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"],
1549 This call creates a file called C<path>. The contents of the
1550 file is the string C<content> (which can contain any 8 bit data),
1551 with length C<size>.
1553 As a special case, if C<size> is C<0>
1554 then the length is calculated using C<strlen> (so in this case
1555 the content cannot contain embedded ASCII NULs).
1557 I<NB.> Owing to a bug, writing content containing ASCII NUL
1558 characters does I<not> work, even if the length is specified.");
1560 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1561 [InitEmpty, Always, TestOutputListOfDevices (
1562 [["part_disk"; "/dev/sda"; "mbr"];
1563 ["mkfs"; "ext2"; "/dev/sda1"];
1564 ["mount_options"; ""; "/dev/sda1"; "/"];
1565 ["mounts"]], ["/dev/sda1"]);
1566 InitEmpty, Always, TestOutputList (
1567 [["part_disk"; "/dev/sda"; "mbr"];
1568 ["mkfs"; "ext2"; "/dev/sda1"];
1569 ["mount_options"; ""; "/dev/sda1"; "/"];
1572 "unmount a filesystem",
1574 This unmounts the given filesystem. The filesystem may be
1575 specified either by its mountpoint (path) or the device which
1576 contains the filesystem.");
1578 ("mounts", (RStringList "devices", []), 46, [],
1579 [InitBasicFS, Always, TestOutputListOfDevices (
1580 [["mounts"]], ["/dev/sda1"])],
1581 "show mounted filesystems",
1583 This returns the list of currently mounted filesystems. It returns
1584 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1586 Some internal mounts are not shown.
1588 See also: C<guestfs_mountpoints>");
1590 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1591 [InitBasicFS, Always, TestOutputList (
1594 (* check that umount_all can unmount nested mounts correctly: *)
1595 InitEmpty, Always, TestOutputList (
1596 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1597 ["mkfs"; "ext2"; "/dev/sda1"];
1598 ["mkfs"; "ext2"; "/dev/sda2"];
1599 ["mkfs"; "ext2"; "/dev/sda3"];
1600 ["mount_options"; ""; "/dev/sda1"; "/"];
1602 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1603 ["mkdir"; "/mp1/mp2"];
1604 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1605 ["mkdir"; "/mp1/mp2/mp3"];
1608 "unmount all filesystems",
1610 This unmounts all mounted filesystems.
1612 Some internal mounts are not unmounted by this call.");
1614 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1616 "remove all LVM LVs, VGs and PVs",
1618 This command removes all LVM logical volumes, volume groups
1619 and physical volumes.");
1621 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1622 [InitISOFS, Always, TestOutput (
1623 [["file"; "/empty"]], "empty");
1624 InitISOFS, Always, TestOutput (
1625 [["file"; "/known-1"]], "ASCII text");
1626 InitISOFS, Always, TestLastFail (
1627 [["file"; "/notexists"]])],
1628 "determine file type",
1630 This call uses the standard L<file(1)> command to determine
1631 the type or contents of the file. This also works on devices,
1632 for example to find out whether a partition contains a filesystem.
1634 This call will also transparently look inside various types
1637 The exact command which runs is C<file -zbsL path>. Note in
1638 particular that the filename is not prepended to the output
1639 (the C<-b> option).");
1641 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1642 [InitBasicFS, Always, TestOutput (
1643 [["upload"; "test-command"; "/test-command"];
1644 ["chmod"; "0o755"; "/test-command"];
1645 ["command"; "/test-command 1"]], "Result1");
1646 InitBasicFS, Always, TestOutput (
1647 [["upload"; "test-command"; "/test-command"];
1648 ["chmod"; "0o755"; "/test-command"];
1649 ["command"; "/test-command 2"]], "Result2\n");
1650 InitBasicFS, Always, TestOutput (
1651 [["upload"; "test-command"; "/test-command"];
1652 ["chmod"; "0o755"; "/test-command"];
1653 ["command"; "/test-command 3"]], "\nResult3");
1654 InitBasicFS, Always, TestOutput (
1655 [["upload"; "test-command"; "/test-command"];
1656 ["chmod"; "0o755"; "/test-command"];
1657 ["command"; "/test-command 4"]], "\nResult4\n");
1658 InitBasicFS, Always, TestOutput (
1659 [["upload"; "test-command"; "/test-command"];
1660 ["chmod"; "0o755"; "/test-command"];
1661 ["command"; "/test-command 5"]], "\nResult5\n\n");
1662 InitBasicFS, Always, TestOutput (
1663 [["upload"; "test-command"; "/test-command"];
1664 ["chmod"; "0o755"; "/test-command"];
1665 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1666 InitBasicFS, Always, TestOutput (
1667 [["upload"; "test-command"; "/test-command"];
1668 ["chmod"; "0o755"; "/test-command"];
1669 ["command"; "/test-command 7"]], "");
1670 InitBasicFS, Always, TestOutput (
1671 [["upload"; "test-command"; "/test-command"];
1672 ["chmod"; "0o755"; "/test-command"];
1673 ["command"; "/test-command 8"]], "\n");
1674 InitBasicFS, Always, TestOutput (
1675 [["upload"; "test-command"; "/test-command"];
1676 ["chmod"; "0o755"; "/test-command"];
1677 ["command"; "/test-command 9"]], "\n\n");
1678 InitBasicFS, Always, TestOutput (
1679 [["upload"; "test-command"; "/test-command"];
1680 ["chmod"; "0o755"; "/test-command"];
1681 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1682 InitBasicFS, Always, TestOutput (
1683 [["upload"; "test-command"; "/test-command"];
1684 ["chmod"; "0o755"; "/test-command"];
1685 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1686 InitBasicFS, Always, TestLastFail (
1687 [["upload"; "test-command"; "/test-command"];
1688 ["chmod"; "0o755"; "/test-command"];
1689 ["command"; "/test-command"]])],
1690 "run a command from the guest filesystem",
1692 This call runs a command from the guest filesystem. The
1693 filesystem must be mounted, and must contain a compatible
1694 operating system (ie. something Linux, with the same
1695 or compatible processor architecture).
1697 The single parameter is an argv-style list of arguments.
1698 The first element is the name of the program to run.
1699 Subsequent elements are parameters. The list must be
1700 non-empty (ie. must contain a program name). Note that
1701 the command runs directly, and is I<not> invoked via
1702 the shell (see C<guestfs_sh>).
1704 The return value is anything printed to I<stdout> by
1707 If the command returns a non-zero exit status, then
1708 this function returns an error message. The error message
1709 string is the content of I<stderr> from the command.
1711 The C<$PATH> environment variable will contain at least
1712 C</usr/bin> and C</bin>. If you require a program from
1713 another location, you should provide the full path in the
1716 Shared libraries and data files required by the program
1717 must be available on filesystems which are mounted in the
1718 correct places. It is the caller's responsibility to ensure
1719 all filesystems that are needed are mounted at the right
1722 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1723 [InitBasicFS, Always, TestOutputList (
1724 [["upload"; "test-command"; "/test-command"];
1725 ["chmod"; "0o755"; "/test-command"];
1726 ["command_lines"; "/test-command 1"]], ["Result1"]);
1727 InitBasicFS, Always, TestOutputList (
1728 [["upload"; "test-command"; "/test-command"];
1729 ["chmod"; "0o755"; "/test-command"];
1730 ["command_lines"; "/test-command 2"]], ["Result2"]);
1731 InitBasicFS, Always, TestOutputList (
1732 [["upload"; "test-command"; "/test-command"];
1733 ["chmod"; "0o755"; "/test-command"];
1734 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1735 InitBasicFS, Always, TestOutputList (
1736 [["upload"; "test-command"; "/test-command"];
1737 ["chmod"; "0o755"; "/test-command"];
1738 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1739 InitBasicFS, Always, TestOutputList (
1740 [["upload"; "test-command"; "/test-command"];
1741 ["chmod"; "0o755"; "/test-command"];
1742 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1743 InitBasicFS, Always, TestOutputList (
1744 [["upload"; "test-command"; "/test-command"];
1745 ["chmod"; "0o755"; "/test-command"];
1746 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1747 InitBasicFS, Always, TestOutputList (
1748 [["upload"; "test-command"; "/test-command"];
1749 ["chmod"; "0o755"; "/test-command"];
1750 ["command_lines"; "/test-command 7"]], []);
1751 InitBasicFS, Always, TestOutputList (
1752 [["upload"; "test-command"; "/test-command"];
1753 ["chmod"; "0o755"; "/test-command"];
1754 ["command_lines"; "/test-command 8"]], [""]);
1755 InitBasicFS, Always, TestOutputList (
1756 [["upload"; "test-command"; "/test-command"];
1757 ["chmod"; "0o755"; "/test-command"];
1758 ["command_lines"; "/test-command 9"]], ["";""]);
1759 InitBasicFS, Always, TestOutputList (
1760 [["upload"; "test-command"; "/test-command"];
1761 ["chmod"; "0o755"; "/test-command"];
1762 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1763 InitBasicFS, Always, TestOutputList (
1764 [["upload"; "test-command"; "/test-command"];
1765 ["chmod"; "0o755"; "/test-command"];
1766 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1767 "run a command, returning lines",
1769 This is the same as C<guestfs_command>, but splits the
1770 result into a list of lines.
1772 See also: C<guestfs_sh_lines>");
1774 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1775 [InitISOFS, Always, TestOutputStruct (
1776 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1777 "get file information",
1779 Returns file information for the given C<path>.
1781 This is the same as the C<stat(2)> system call.");
1783 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1784 [InitISOFS, Always, TestOutputStruct (
1785 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1786 "get file information for a symbolic link",
1788 Returns file information for the given C<path>.
1790 This is the same as C<guestfs_stat> except that if C<path>
1791 is a symbolic link, then the link is stat-ed, not the file it
1794 This is the same as the C<lstat(2)> system call.");
1796 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1797 [InitISOFS, Always, TestOutputStruct (
1798 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1799 "get file system statistics",
1801 Returns file system statistics for any mounted file system.
1802 C<path> should be a file or directory in the mounted file system
1803 (typically it is the mount point itself, but it doesn't need to be).
1805 This is the same as the C<statvfs(2)> system call.");
1807 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1809 "get ext2/ext3/ext4 superblock details",
1811 This returns the contents of the ext2, ext3 or ext4 filesystem
1812 superblock on C<device>.
1814 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1815 manpage for more details. The list of fields returned isn't
1816 clearly defined, and depends on both the version of C<tune2fs>
1817 that libguestfs was built against, and the filesystem itself.");
1819 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1820 [InitEmpty, Always, TestOutputTrue (
1821 [["blockdev_setro"; "/dev/sda"];
1822 ["blockdev_getro"; "/dev/sda"]])],
1823 "set block device to read-only",
1825 Sets the block device named C<device> to read-only.
1827 This uses the L<blockdev(8)> command.");
1829 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1830 [InitEmpty, Always, TestOutputFalse (
1831 [["blockdev_setrw"; "/dev/sda"];
1832 ["blockdev_getro"; "/dev/sda"]])],
1833 "set block device to read-write",
1835 Sets the block device named C<device> to read-write.
1837 This uses the L<blockdev(8)> command.");
1839 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1840 [InitEmpty, Always, TestOutputTrue (
1841 [["blockdev_setro"; "/dev/sda"];
1842 ["blockdev_getro"; "/dev/sda"]])],
1843 "is block device set to read-only",
1845 Returns a boolean indicating if the block device is read-only
1846 (true if read-only, false if not).
1848 This uses the L<blockdev(8)> command.");
1850 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1851 [InitEmpty, Always, TestOutputInt (
1852 [["blockdev_getss"; "/dev/sda"]], 512)],
1853 "get sectorsize of block device",
1855 This returns the size of sectors on a block device.
1856 Usually 512, but can be larger for modern devices.
1858 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1861 This uses the L<blockdev(8)> command.");
1863 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1864 [InitEmpty, Always, TestOutputInt (
1865 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1866 "get blocksize of block device",
1868 This returns the block size of a device.
1870 (Note this is different from both I<size in blocks> and
1871 I<filesystem block size>).
1873 This uses the L<blockdev(8)> command.");
1875 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1877 "set blocksize of block device",
1879 This sets the block size of a device.
1881 (Note this is different from both I<size in blocks> and
1882 I<filesystem block size>).
1884 This uses the L<blockdev(8)> command.");
1886 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1887 [InitEmpty, Always, TestOutputInt (
1888 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1889 "get total size of device in 512-byte sectors",
1891 This returns the size of the device in units of 512-byte sectors
1892 (even if the sectorsize isn't 512 bytes ... weird).
1894 See also C<guestfs_blockdev_getss> for the real sector size of
1895 the device, and C<guestfs_blockdev_getsize64> for the more
1896 useful I<size in bytes>.
1898 This uses the L<blockdev(8)> command.");
1900 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1901 [InitEmpty, Always, TestOutputInt (
1902 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1903 "get total size of device in bytes",
1905 This returns the size of the device in bytes.
1907 See also C<guestfs_blockdev_getsz>.
1909 This uses the L<blockdev(8)> command.");
1911 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1912 [InitEmpty, Always, TestRun
1913 [["blockdev_flushbufs"; "/dev/sda"]]],
1914 "flush device buffers",
1916 This tells the kernel to flush internal buffers associated
1919 This uses the L<blockdev(8)> command.");
1921 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1922 [InitEmpty, Always, TestRun
1923 [["blockdev_rereadpt"; "/dev/sda"]]],
1924 "reread partition table",
1926 Reread the partition table on C<device>.
1928 This uses the L<blockdev(8)> command.");
1930 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1931 [InitBasicFS, Always, TestOutput (
1932 (* Pick a file from cwd which isn't likely to change. *)
1933 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1934 ["checksum"; "md5"; "/COPYING.LIB"]],
1935 Digest.to_hex (Digest.file "COPYING.LIB"))],
1936 "upload a file from the local machine",
1938 Upload local file C<filename> to C<remotefilename> on the
1941 C<filename> can also be a named pipe.
1943 See also C<guestfs_download>.");
1945 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1946 [InitBasicFS, Always, TestOutput (
1947 (* Pick a file from cwd which isn't likely to change. *)
1948 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1949 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1950 ["upload"; "testdownload.tmp"; "/upload"];
1951 ["checksum"; "md5"; "/upload"]],
1952 Digest.to_hex (Digest.file "COPYING.LIB"))],
1953 "download a file to the local machine",
1955 Download file C<remotefilename> and save it as C<filename>
1956 on the local machine.
1958 C<filename> can also be a named pipe.
1960 See also C<guestfs_upload>, C<guestfs_cat>.");
1962 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1963 [InitISOFS, Always, TestOutput (
1964 [["checksum"; "crc"; "/known-3"]], "2891671662");
1965 InitISOFS, Always, TestLastFail (
1966 [["checksum"; "crc"; "/notexists"]]);
1967 InitISOFS, Always, TestOutput (
1968 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1969 InitISOFS, Always, TestOutput (
1970 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1971 InitISOFS, Always, TestOutput (
1972 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1973 InitISOFS, Always, TestOutput (
1974 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1975 InitISOFS, Always, TestOutput (
1976 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1977 InitISOFS, Always, TestOutput (
1978 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
1979 (* Test for RHBZ#579608, absolute symbolic links. *)
1980 InitISOFS, Always, TestOutput (
1981 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
1982 "compute MD5, SHAx or CRC checksum of file",
1984 This call computes the MD5, SHAx or CRC checksum of the
1987 The type of checksum to compute is given by the C<csumtype>
1988 parameter which must have one of the following values:
1994 Compute the cyclic redundancy check (CRC) specified by POSIX
1995 for the C<cksum> command.
1999 Compute the MD5 hash (using the C<md5sum> program).
2003 Compute the SHA1 hash (using the C<sha1sum> program).
2007 Compute the SHA224 hash (using the C<sha224sum> program).
2011 Compute the SHA256 hash (using the C<sha256sum> program).
2015 Compute the SHA384 hash (using the C<sha384sum> program).
2019 Compute the SHA512 hash (using the C<sha512sum> program).
2023 The checksum is returned as a printable string.
2025 To get the checksum for a device, use C<guestfs_checksum_device>.
2027 To get the checksums for many files, use C<guestfs_checksums_out>.");
2029 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2030 [InitBasicFS, Always, TestOutput (
2031 [["tar_in"; "../images/helloworld.tar"; "/"];
2032 ["cat"; "/hello"]], "hello\n")],
2033 "unpack tarfile to directory",
2035 This command uploads and unpacks local file C<tarfile> (an
2036 I<uncompressed> tar file) into C<directory>.
2038 To upload a compressed tarball, use C<guestfs_tgz_in>
2039 or C<guestfs_txz_in>.");
2041 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2043 "pack directory into tarfile",
2045 This command packs the contents of C<directory> and downloads
2046 it to local file C<tarfile>.
2048 To download a compressed tarball, use C<guestfs_tgz_out>
2049 or C<guestfs_txz_out>.");
2051 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2052 [InitBasicFS, Always, TestOutput (
2053 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2054 ["cat"; "/hello"]], "hello\n")],
2055 "unpack compressed tarball to directory",
2057 This command uploads and unpacks local file C<tarball> (a
2058 I<gzip compressed> tar file) into C<directory>.
2060 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2062 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2064 "pack directory into compressed tarball",
2066 This command packs the contents of C<directory> and downloads
2067 it to local file C<tarball>.
2069 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2071 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2072 [InitBasicFS, Always, TestLastFail (
2074 ["mount_ro"; "/dev/sda1"; "/"];
2075 ["touch"; "/new"]]);
2076 InitBasicFS, Always, TestOutput (
2077 [["write"; "/new"; "data"];
2079 ["mount_ro"; "/dev/sda1"; "/"];
2080 ["cat"; "/new"]], "data")],
2081 "mount a guest disk, read-only",
2083 This is the same as the C<guestfs_mount> command, but it
2084 mounts the filesystem with the read-only (I<-o ro>) flag.");
2086 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2088 "mount a guest disk with mount options",
2090 This is the same as the C<guestfs_mount> command, but it
2091 allows you to set the mount options as for the
2092 L<mount(8)> I<-o> flag.
2094 If the C<options> parameter is an empty string, then
2095 no options are passed (all options default to whatever
2096 the filesystem uses).");
2098 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2100 "mount a guest disk with mount options and vfstype",
2102 This is the same as the C<guestfs_mount> command, but it
2103 allows you to set both the mount options and the vfstype
2104 as for the L<mount(8)> I<-o> and I<-t> flags.");
2106 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2108 "debugging and internals",
2110 The C<guestfs_debug> command exposes some internals of
2111 C<guestfsd> (the guestfs daemon) that runs inside the
2114 There is no comprehensive help for this command. You have
2115 to look at the file C<daemon/debug.c> in the libguestfs source
2116 to find out what you can do.");
2118 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2119 [InitEmpty, Always, TestOutputList (
2120 [["part_disk"; "/dev/sda"; "mbr"];
2121 ["pvcreate"; "/dev/sda1"];
2122 ["vgcreate"; "VG"; "/dev/sda1"];
2123 ["lvcreate"; "LV1"; "VG"; "50"];
2124 ["lvcreate"; "LV2"; "VG"; "50"];
2125 ["lvremove"; "/dev/VG/LV1"];
2126 ["lvs"]], ["/dev/VG/LV2"]);
2127 InitEmpty, Always, TestOutputList (
2128 [["part_disk"; "/dev/sda"; "mbr"];
2129 ["pvcreate"; "/dev/sda1"];
2130 ["vgcreate"; "VG"; "/dev/sda1"];
2131 ["lvcreate"; "LV1"; "VG"; "50"];
2132 ["lvcreate"; "LV2"; "VG"; "50"];
2133 ["lvremove"; "/dev/VG"];
2135 InitEmpty, Always, TestOutputList (
2136 [["part_disk"; "/dev/sda"; "mbr"];
2137 ["pvcreate"; "/dev/sda1"];
2138 ["vgcreate"; "VG"; "/dev/sda1"];
2139 ["lvcreate"; "LV1"; "VG"; "50"];
2140 ["lvcreate"; "LV2"; "VG"; "50"];
2141 ["lvremove"; "/dev/VG"];
2143 "remove an LVM logical volume",
2145 Remove an LVM logical volume C<device>, where C<device> is
2146 the path to the LV, such as C</dev/VG/LV>.
2148 You can also remove all LVs in a volume group by specifying
2149 the VG name, C</dev/VG>.");
2151 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2152 [InitEmpty, Always, TestOutputList (
2153 [["part_disk"; "/dev/sda"; "mbr"];
2154 ["pvcreate"; "/dev/sda1"];
2155 ["vgcreate"; "VG"; "/dev/sda1"];
2156 ["lvcreate"; "LV1"; "VG"; "50"];
2157 ["lvcreate"; "LV2"; "VG"; "50"];
2160 InitEmpty, Always, TestOutputList (
2161 [["part_disk"; "/dev/sda"; "mbr"];
2162 ["pvcreate"; "/dev/sda1"];
2163 ["vgcreate"; "VG"; "/dev/sda1"];
2164 ["lvcreate"; "LV1"; "VG"; "50"];
2165 ["lvcreate"; "LV2"; "VG"; "50"];
2168 "remove an LVM volume group",
2170 Remove an LVM volume group C<vgname>, (for example C<VG>).
2172 This also forcibly removes all logical volumes in the volume
2175 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2176 [InitEmpty, Always, TestOutputListOfDevices (
2177 [["part_disk"; "/dev/sda"; "mbr"];
2178 ["pvcreate"; "/dev/sda1"];
2179 ["vgcreate"; "VG"; "/dev/sda1"];
2180 ["lvcreate"; "LV1"; "VG"; "50"];
2181 ["lvcreate"; "LV2"; "VG"; "50"];
2183 ["pvremove"; "/dev/sda1"];
2185 InitEmpty, Always, TestOutputListOfDevices (
2186 [["part_disk"; "/dev/sda"; "mbr"];
2187 ["pvcreate"; "/dev/sda1"];
2188 ["vgcreate"; "VG"; "/dev/sda1"];
2189 ["lvcreate"; "LV1"; "VG"; "50"];
2190 ["lvcreate"; "LV2"; "VG"; "50"];
2192 ["pvremove"; "/dev/sda1"];
2194 InitEmpty, Always, TestOutputListOfDevices (
2195 [["part_disk"; "/dev/sda"; "mbr"];
2196 ["pvcreate"; "/dev/sda1"];
2197 ["vgcreate"; "VG"; "/dev/sda1"];
2198 ["lvcreate"; "LV1"; "VG"; "50"];
2199 ["lvcreate"; "LV2"; "VG"; "50"];
2201 ["pvremove"; "/dev/sda1"];
2203 "remove an LVM physical volume",
2205 This wipes a physical volume C<device> so that LVM will no longer
2208 The implementation uses the C<pvremove> command which refuses to
2209 wipe physical volumes that contain any volume groups, so you have
2210 to remove those first.");
2212 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2213 [InitBasicFS, Always, TestOutput (
2214 [["set_e2label"; "/dev/sda1"; "testlabel"];
2215 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2216 "set the ext2/3/4 filesystem label",
2218 This sets the ext2/3/4 filesystem label of the filesystem on
2219 C<device> to C<label>. Filesystem labels are limited to
2222 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2223 to return the existing label on a filesystem.");
2225 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2227 "get the ext2/3/4 filesystem label",
2229 This returns the ext2/3/4 filesystem label of the filesystem on
2232 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2233 (let uuid = uuidgen () in
2234 [InitBasicFS, Always, TestOutput (
2235 [["set_e2uuid"; "/dev/sda1"; uuid];
2236 ["get_e2uuid"; "/dev/sda1"]], uuid);
2237 InitBasicFS, Always, TestOutput (
2238 [["set_e2uuid"; "/dev/sda1"; "clear"];
2239 ["get_e2uuid"; "/dev/sda1"]], "");
2240 (* We can't predict what UUIDs will be, so just check the commands run. *)
2241 InitBasicFS, Always, TestRun (
2242 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2243 InitBasicFS, Always, TestRun (
2244 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2245 "set the ext2/3/4 filesystem UUID",
2247 This sets the ext2/3/4 filesystem UUID of the filesystem on
2248 C<device> to C<uuid>. The format of the UUID and alternatives
2249 such as C<clear>, C<random> and C<time> are described in the
2250 L<tune2fs(8)> manpage.
2252 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2253 to return the existing UUID of a filesystem.");
2255 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2256 (* Regression test for RHBZ#597112. *)
2257 (let uuid = uuidgen () in
2258 [InitBasicFS, Always, TestOutput (
2259 [["mke2journal"; "1024"; "/dev/sdb"];
2260 ["set_e2uuid"; "/dev/sdb"; uuid];
2261 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2262 "get the ext2/3/4 filesystem UUID",
2264 This returns the ext2/3/4 filesystem UUID of the filesystem on
2267 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2268 [InitBasicFS, Always, TestOutputInt (
2269 [["umount"; "/dev/sda1"];
2270 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2271 InitBasicFS, Always, TestOutputInt (
2272 [["umount"; "/dev/sda1"];
2273 ["zero"; "/dev/sda1"];
2274 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2275 "run the filesystem checker",
2277 This runs the filesystem checker (fsck) on C<device> which
2278 should have filesystem type C<fstype>.
2280 The returned integer is the status. See L<fsck(8)> for the
2281 list of status codes from C<fsck>.
2289 Multiple status codes can be summed together.
2293 A non-zero return code can mean \"success\", for example if
2294 errors have been corrected on the filesystem.
2298 Checking or repairing NTFS volumes is not supported
2303 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2305 ("zero", (RErr, [Device "device"]), 85, [],
2306 [InitBasicFS, Always, TestOutput (
2307 [["umount"; "/dev/sda1"];
2308 ["zero"; "/dev/sda1"];
2309 ["file"; "/dev/sda1"]], "data")],
2310 "write zeroes to the device",
2312 This command writes zeroes over the first few blocks of C<device>.
2314 How many blocks are zeroed isn't specified (but it's I<not> enough
2315 to securely wipe the device). It should be sufficient to remove
2316 any partition tables, filesystem superblocks and so on.
2318 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2320 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2321 (* Test disabled because grub-install incompatible with virtio-blk driver.
2322 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2324 [InitBasicFS, Disabled, TestOutputTrue (
2325 [["grub_install"; "/"; "/dev/sda1"];
2326 ["is_dir"; "/boot"]])],
2329 This command installs GRUB (the Grand Unified Bootloader) on
2330 C<device>, with the root directory being C<root>.");
2332 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2333 [InitBasicFS, Always, TestOutput (
2334 [["write"; "/old"; "file content"];
2335 ["cp"; "/old"; "/new"];
2336 ["cat"; "/new"]], "file content");
2337 InitBasicFS, Always, TestOutputTrue (
2338 [["write"; "/old"; "file content"];
2339 ["cp"; "/old"; "/new"];
2340 ["is_file"; "/old"]]);
2341 InitBasicFS, Always, TestOutput (
2342 [["write"; "/old"; "file content"];
2344 ["cp"; "/old"; "/dir/new"];
2345 ["cat"; "/dir/new"]], "file content")],
2348 This copies a file from C<src> to C<dest> where C<dest> is
2349 either a destination filename or destination directory.");
2351 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2352 [InitBasicFS, Always, TestOutput (
2353 [["mkdir"; "/olddir"];
2354 ["mkdir"; "/newdir"];
2355 ["write"; "/olddir/file"; "file content"];
2356 ["cp_a"; "/olddir"; "/newdir"];
2357 ["cat"; "/newdir/olddir/file"]], "file content")],
2358 "copy a file or directory recursively",
2360 This copies a file or directory from C<src> to C<dest>
2361 recursively using the C<cp -a> command.");
2363 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2364 [InitBasicFS, Always, TestOutput (
2365 [["write"; "/old"; "file content"];
2366 ["mv"; "/old"; "/new"];
2367 ["cat"; "/new"]], "file content");
2368 InitBasicFS, Always, TestOutputFalse (
2369 [["write"; "/old"; "file content"];
2370 ["mv"; "/old"; "/new"];
2371 ["is_file"; "/old"]])],
2374 This moves a file from C<src> to C<dest> where C<dest> is
2375 either a destination filename or destination directory.");
2377 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2378 [InitEmpty, Always, TestRun (
2379 [["drop_caches"; "3"]])],
2380 "drop kernel page cache, dentries and inodes",
2382 This instructs the guest kernel to drop its page cache,
2383 and/or dentries and inode caches. The parameter C<whattodrop>
2384 tells the kernel what precisely to drop, see
2385 L<http://linux-mm.org/Drop_Caches>
2387 Setting C<whattodrop> to 3 should drop everything.
2389 This automatically calls L<sync(2)> before the operation,
2390 so that the maximum guest memory is freed.");
2392 ("dmesg", (RString "kmsgs", []), 91, [],
2393 [InitEmpty, Always, TestRun (
2395 "return kernel messages",
2397 This returns the kernel messages (C<dmesg> output) from
2398 the guest kernel. This is sometimes useful for extended
2399 debugging of problems.
2401 Another way to get the same information is to enable
2402 verbose messages with C<guestfs_set_verbose> or by setting
2403 the environment variable C<LIBGUESTFS_DEBUG=1> before
2404 running the program.");
2406 ("ping_daemon", (RErr, []), 92, [],
2407 [InitEmpty, Always, TestRun (
2408 [["ping_daemon"]])],
2409 "ping the guest daemon",
2411 This is a test probe into the guestfs daemon running inside
2412 the qemu subprocess. Calling this function checks that the
2413 daemon responds to the ping message, without affecting the daemon
2414 or attached block device(s) in any other way.");
2416 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2417 [InitBasicFS, Always, TestOutputTrue (
2418 [["write"; "/file1"; "contents of a file"];
2419 ["cp"; "/file1"; "/file2"];
2420 ["equal"; "/file1"; "/file2"]]);
2421 InitBasicFS, Always, TestOutputFalse (
2422 [["write"; "/file1"; "contents of a file"];
2423 ["write"; "/file2"; "contents of another file"];
2424 ["equal"; "/file1"; "/file2"]]);
2425 InitBasicFS, Always, TestLastFail (
2426 [["equal"; "/file1"; "/file2"]])],
2427 "test if two files have equal contents",
2429 This compares the two files C<file1> and C<file2> and returns
2430 true if their content is exactly equal, or false otherwise.
2432 The external L<cmp(1)> program is used for the comparison.");
2434 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2435 [InitISOFS, Always, TestOutputList (
2436 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2437 InitISOFS, Always, TestOutputList (
2438 [["strings"; "/empty"]], []);
2439 (* Test for RHBZ#579608, absolute symbolic links. *)
2440 InitISOFS, Always, TestRun (
2441 [["strings"; "/abssymlink"]])],
2442 "print the printable strings in a file",
2444 This runs the L<strings(1)> command on a file and returns
2445 the list of printable strings found.");
2447 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2448 [InitISOFS, Always, TestOutputList (
2449 [["strings_e"; "b"; "/known-5"]], []);
2450 InitBasicFS, Always, TestOutputList (
2451 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2452 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2453 "print the printable strings in a file",
2455 This is like the C<guestfs_strings> command, but allows you to
2456 specify the encoding of strings that are looked for in
2457 the source file C<path>.
2459 Allowed encodings are:
2465 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2466 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2470 Single 8-bit-byte characters.
2474 16-bit big endian strings such as those encoded in
2475 UTF-16BE or UCS-2BE.
2477 =item l (lower case letter L)
2479 16-bit little endian such as UTF-16LE and UCS-2LE.
2480 This is useful for examining binaries in Windows guests.
2484 32-bit big endian such as UCS-4BE.
2488 32-bit little endian such as UCS-4LE.
2492 The returned strings are transcoded to UTF-8.");
2494 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2495 [InitISOFS, Always, TestOutput (
2496 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2497 (* Test for RHBZ#501888c2 regression which caused large hexdump
2498 * commands to segfault.
2500 InitISOFS, Always, TestRun (
2501 [["hexdump"; "/100krandom"]]);
2502 (* Test for RHBZ#579608, absolute symbolic links. *)
2503 InitISOFS, Always, TestRun (
2504 [["hexdump"; "/abssymlink"]])],
2505 "dump a file in hexadecimal",
2507 This runs C<hexdump -C> on the given C<path>. The result is
2508 the human-readable, canonical hex dump of the file.");
2510 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2511 [InitNone, Always, TestOutput (
2512 [["part_disk"; "/dev/sda"; "mbr"];
2513 ["mkfs"; "ext3"; "/dev/sda1"];
2514 ["mount_options"; ""; "/dev/sda1"; "/"];
2515 ["write"; "/new"; "test file"];
2516 ["umount"; "/dev/sda1"];
2517 ["zerofree"; "/dev/sda1"];
2518 ["mount_options"; ""; "/dev/sda1"; "/"];
2519 ["cat"; "/new"]], "test file")],
2520 "zero unused inodes and disk blocks on ext2/3 filesystem",
2522 This runs the I<zerofree> program on C<device>. This program
2523 claims to zero unused inodes and disk blocks on an ext2/3
2524 filesystem, thus making it possible to compress the filesystem
2527 You should B<not> run this program if the filesystem is
2530 It is possible that using this program can damage the filesystem
2531 or data on the filesystem.");
2533 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2535 "resize an LVM physical volume",
2537 This resizes (expands or shrinks) an existing LVM physical
2538 volume to match the new size of the underlying device.");
2540 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2541 Int "cyls"; Int "heads"; Int "sectors";
2542 String "line"]), 99, [DangerWillRobinson],
2544 "modify a single partition on a block device",
2546 This runs L<sfdisk(8)> option to modify just the single
2547 partition C<n> (note: C<n> counts from 1).
2549 For other parameters, see C<guestfs_sfdisk>. You should usually
2550 pass C<0> for the cyls/heads/sectors parameters.
2552 See also: C<guestfs_part_add>");
2554 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2556 "display the partition table",
2558 This displays the partition table on C<device>, in the
2559 human-readable output of the L<sfdisk(8)> command. It is
2560 not intended to be parsed.
2562 See also: C<guestfs_part_list>");
2564 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2566 "display the kernel geometry",
2568 This displays the kernel's idea of the geometry of C<device>.
2570 The result is in human-readable format, and not designed to
2573 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2575 "display the disk geometry from the partition table",
2577 This displays the disk geometry of C<device> read from the
2578 partition table. Especially in the case where the underlying
2579 block device has been resized, this can be different from the
2580 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2582 The result is in human-readable format, and not designed to
2585 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2587 "activate or deactivate all volume groups",
2589 This command activates or (if C<activate> is false) deactivates
2590 all logical volumes in all volume groups.
2591 If activated, then they are made known to the
2592 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2593 then those devices disappear.
2595 This command is the same as running C<vgchange -a y|n>");
2597 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2599 "activate or deactivate some volume groups",
2601 This command activates or (if C<activate> is false) deactivates
2602 all logical volumes in the listed volume groups C<volgroups>.
2603 If activated, then they are made known to the
2604 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2605 then those devices disappear.
2607 This command is the same as running C<vgchange -a y|n volgroups...>
2609 Note that if C<volgroups> is an empty list then B<all> volume groups
2610 are activated or deactivated.");
2612 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2613 [InitNone, Always, TestOutput (
2614 [["part_disk"; "/dev/sda"; "mbr"];
2615 ["pvcreate"; "/dev/sda1"];
2616 ["vgcreate"; "VG"; "/dev/sda1"];
2617 ["lvcreate"; "LV"; "VG"; "10"];
2618 ["mkfs"; "ext2"; "/dev/VG/LV"];
2619 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2620 ["write"; "/new"; "test content"];
2622 ["lvresize"; "/dev/VG/LV"; "20"];
2623 ["e2fsck_f"; "/dev/VG/LV"];
2624 ["resize2fs"; "/dev/VG/LV"];
2625 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2626 ["cat"; "/new"]], "test content");
2627 InitNone, Always, TestRun (
2628 (* Make an LV smaller to test RHBZ#587484. *)
2629 [["part_disk"; "/dev/sda"; "mbr"];
2630 ["pvcreate"; "/dev/sda1"];
2631 ["vgcreate"; "VG"; "/dev/sda1"];
2632 ["lvcreate"; "LV"; "VG"; "20"];
2633 ["lvresize"; "/dev/VG/LV"; "10"]])],
2634 "resize an LVM logical volume",
2636 This resizes (expands or shrinks) an existing LVM logical
2637 volume to C<mbytes>. When reducing, data in the reduced part
2640 ("resize2fs", (RErr, [Device "device"]), 106, [],
2641 [], (* lvresize tests this *)
2642 "resize an ext2/ext3 filesystem",
2644 This resizes an ext2 or ext3 filesystem to match the size of
2645 the underlying device.
2647 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2648 on the C<device> before calling this command. For unknown reasons
2649 C<resize2fs> sometimes gives an error about this and sometimes not.
2650 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2651 calling this function.");
2653 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2654 [InitBasicFS, Always, TestOutputList (
2655 [["find"; "/"]], ["lost+found"]);
2656 InitBasicFS, Always, TestOutputList (
2660 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2661 InitBasicFS, Always, TestOutputList (
2662 [["mkdir_p"; "/a/b/c"];
2663 ["touch"; "/a/b/c/d"];
2664 ["find"; "/a/b/"]], ["c"; "c/d"])],
2665 "find all files and directories",
2667 This command lists out all files and directories, recursively,
2668 starting at C<directory>. It is essentially equivalent to
2669 running the shell command C<find directory -print> but some
2670 post-processing happens on the output, described below.
2672 This returns a list of strings I<without any prefix>. Thus
2673 if the directory structure was:
2679 then the returned list from C<guestfs_find> C</tmp> would be
2687 If C<directory> is not a directory, then this command returns
2690 The returned list is sorted.
2692 See also C<guestfs_find0>.");
2694 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2695 [], (* lvresize tests this *)
2696 "check an ext2/ext3 filesystem",
2698 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2699 filesystem checker on C<device>, noninteractively (C<-p>),
2700 even if the filesystem appears to be clean (C<-f>).
2702 This command is only needed because of C<guestfs_resize2fs>
2703 (q.v.). Normally you should use C<guestfs_fsck>.");
2705 ("sleep", (RErr, [Int "secs"]), 109, [],
2706 [InitNone, Always, TestRun (
2708 "sleep for some seconds",
2710 Sleep for C<secs> seconds.");
2712 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2713 [InitNone, Always, TestOutputInt (
2714 [["part_disk"; "/dev/sda"; "mbr"];
2715 ["mkfs"; "ntfs"; "/dev/sda1"];
2716 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2717 InitNone, Always, TestOutputInt (
2718 [["part_disk"; "/dev/sda"; "mbr"];
2719 ["mkfs"; "ext2"; "/dev/sda1"];
2720 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2721 "probe NTFS volume",
2723 This command runs the L<ntfs-3g.probe(8)> command which probes
2724 an NTFS C<device> for mountability. (Not all NTFS volumes can
2725 be mounted read-write, and some cannot be mounted at all).
2727 C<rw> is a boolean flag. Set it to true if you want to test
2728 if the volume can be mounted read-write. Set it to false if
2729 you want to test if the volume can be mounted read-only.
2731 The return value is an integer which C<0> if the operation
2732 would succeed, or some non-zero value documented in the
2733 L<ntfs-3g.probe(8)> manual page.");
2735 ("sh", (RString "output", [String "command"]), 111, [],
2736 [], (* XXX needs tests *)
2737 "run a command via the shell",
2739 This call runs a command from the guest filesystem via the
2742 This is like C<guestfs_command>, but passes the command to:
2744 /bin/sh -c \"command\"
2746 Depending on the guest's shell, this usually results in
2747 wildcards being expanded, shell expressions being interpolated
2750 All the provisos about C<guestfs_command> apply to this call.");
2752 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2753 [], (* XXX needs tests *)
2754 "run a command via the shell returning lines",
2756 This is the same as C<guestfs_sh>, but splits the result
2757 into a list of lines.
2759 See also: C<guestfs_command_lines>");
2761 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2762 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2763 * code in stubs.c, since all valid glob patterns must start with "/".
2764 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2766 [InitBasicFS, Always, TestOutputList (
2767 [["mkdir_p"; "/a/b/c"];
2768 ["touch"; "/a/b/c/d"];
2769 ["touch"; "/a/b/c/e"];
2770 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2771 InitBasicFS, Always, TestOutputList (
2772 [["mkdir_p"; "/a/b/c"];
2773 ["touch"; "/a/b/c/d"];
2774 ["touch"; "/a/b/c/e"];
2775 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2776 InitBasicFS, Always, TestOutputList (
2777 [["mkdir_p"; "/a/b/c"];
2778 ["touch"; "/a/b/c/d"];
2779 ["touch"; "/a/b/c/e"];
2780 ["glob_expand"; "/a/*/x/*"]], [])],
2781 "expand a wildcard path",
2783 This command searches for all the pathnames matching
2784 C<pattern> according to the wildcard expansion rules
2787 If no paths match, then this returns an empty list
2788 (note: not an error).
2790 It is just a wrapper around the C L<glob(3)> function
2791 with flags C<GLOB_MARK|GLOB_BRACE>.
2792 See that manual page for more details.");
2794 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2795 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2796 [["scrub_device"; "/dev/sdc"]])],
2797 "scrub (securely wipe) a device",
2799 This command writes patterns over C<device> to make data retrieval
2802 It is an interface to the L<scrub(1)> program. See that
2803 manual page for more details.");
2805 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2806 [InitBasicFS, Always, TestRun (
2807 [["write"; "/file"; "content"];
2808 ["scrub_file"; "/file"]])],
2809 "scrub (securely wipe) a file",
2811 This command writes patterns over a file to make data retrieval
2814 The file is I<removed> after scrubbing.
2816 It is an interface to the L<scrub(1)> program. See that
2817 manual page for more details.");
2819 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2820 [], (* XXX needs testing *)
2821 "scrub (securely wipe) free space",
2823 This command creates the directory C<dir> and then fills it
2824 with files until the filesystem is full, and scrubs the files
2825 as for C<guestfs_scrub_file>, and deletes them.
2826 The intention is to scrub any free space on the partition
2829 It is an interface to the L<scrub(1)> program. See that
2830 manual page for more details.");
2832 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2833 [InitBasicFS, Always, TestRun (
2835 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2836 "create a temporary directory",
2838 This command creates a temporary directory. The
2839 C<template> parameter should be a full pathname for the
2840 temporary directory name with the final six characters being
2843 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2844 the second one being suitable for Windows filesystems.
2846 The name of the temporary directory that was created
2849 The temporary directory is created with mode 0700
2850 and is owned by root.
2852 The caller is responsible for deleting the temporary
2853 directory and its contents after use.
2855 See also: L<mkdtemp(3)>");
2857 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2858 [InitISOFS, Always, TestOutputInt (
2859 [["wc_l"; "/10klines"]], 10000);
2860 (* Test for RHBZ#579608, absolute symbolic links. *)
2861 InitISOFS, Always, TestOutputInt (
2862 [["wc_l"; "/abssymlink"]], 10000)],
2863 "count lines in a file",
2865 This command counts the lines in a file, using the
2866 C<wc -l> external command.");
2868 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2869 [InitISOFS, Always, TestOutputInt (
2870 [["wc_w"; "/10klines"]], 10000)],
2871 "count words in a file",
2873 This command counts the words in a file, using the
2874 C<wc -w> external command.");
2876 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2877 [InitISOFS, Always, TestOutputInt (
2878 [["wc_c"; "/100kallspaces"]], 102400)],
2879 "count characters in a file",
2881 This command counts the characters in a file, using the
2882 C<wc -c> external command.");
2884 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2885 [InitISOFS, Always, TestOutputList (
2886 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2887 (* Test for RHBZ#579608, absolute symbolic links. *)
2888 InitISOFS, Always, TestOutputList (
2889 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2890 "return first 10 lines of a file",
2892 This command returns up to the first 10 lines of a file as
2893 a list of strings.");
2895 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2896 [InitISOFS, Always, TestOutputList (
2897 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2898 InitISOFS, Always, TestOutputList (
2899 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2900 InitISOFS, Always, TestOutputList (
2901 [["head_n"; "0"; "/10klines"]], [])],
2902 "return first N lines of a file",
2904 If the parameter C<nrlines> is a positive number, this returns the first
2905 C<nrlines> lines of the file C<path>.
2907 If the parameter C<nrlines> is a negative number, this returns lines
2908 from the file C<path>, excluding the last C<nrlines> lines.
2910 If the parameter C<nrlines> is zero, this returns an empty list.");
2912 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2913 [InitISOFS, Always, TestOutputList (
2914 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2915 "return last 10 lines of a file",
2917 This command returns up to the last 10 lines of a file as
2918 a list of strings.");
2920 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2921 [InitISOFS, Always, TestOutputList (
2922 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2923 InitISOFS, Always, TestOutputList (
2924 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2925 InitISOFS, Always, TestOutputList (
2926 [["tail_n"; "0"; "/10klines"]], [])],
2927 "return last N lines of a file",
2929 If the parameter C<nrlines> is a positive number, this returns the last
2930 C<nrlines> lines of the file C<path>.
2932 If the parameter C<nrlines> is a negative number, this returns lines
2933 from the file C<path>, starting with the C<-nrlines>th line.
2935 If the parameter C<nrlines> is zero, this returns an empty list.");
2937 ("df", (RString "output", []), 125, [],
2938 [], (* XXX Tricky to test because it depends on the exact format
2939 * of the 'df' command and other imponderables.
2941 "report file system disk space usage",
2943 This command runs the C<df> command to report disk space used.
2945 This command is mostly useful for interactive sessions. It
2946 is I<not> intended that you try to parse the output string.
2947 Use C<statvfs> from programs.");
2949 ("df_h", (RString "output", []), 126, [],
2950 [], (* XXX Tricky to test because it depends on the exact format
2951 * of the 'df' command and other imponderables.
2953 "report file system disk space usage (human readable)",
2955 This command runs the C<df -h> command to report disk space used
2956 in human-readable format.
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 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2963 [InitISOFS, Always, TestOutputInt (
2964 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2965 "estimate file space usage",
2967 This command runs the C<du -s> command to estimate file space
2970 C<path> can be a file or a directory. If C<path> is a directory
2971 then the estimate includes the contents of the directory and all
2972 subdirectories (recursively).
2974 The result is the estimated size in I<kilobytes>
2975 (ie. units of 1024 bytes).");
2977 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2978 [InitISOFS, Always, TestOutputList (
2979 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2980 "list files in an initrd",
2982 This command lists out files contained in an initrd.
2984 The files are listed without any initial C</> character. The
2985 files are listed in the order they appear (not necessarily
2986 alphabetical). Directory names are listed as separate items.
2988 Old Linux kernels (2.4 and earlier) used a compressed ext2
2989 filesystem as initrd. We I<only> support the newer initramfs
2990 format (compressed cpio files).");
2992 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2994 "mount a file using the loop device",
2996 This command lets you mount C<file> (a filesystem image
2997 in a file) on a mount point. It is entirely equivalent to
2998 the command C<mount -o loop file mountpoint>.");
3000 ("mkswap", (RErr, [Device "device"]), 130, [],
3001 [InitEmpty, Always, TestRun (
3002 [["part_disk"; "/dev/sda"; "mbr"];
3003 ["mkswap"; "/dev/sda1"]])],
3004 "create a swap partition",
3006 Create a swap partition on C<device>.");
3008 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3009 [InitEmpty, Always, TestRun (
3010 [["part_disk"; "/dev/sda"; "mbr"];
3011 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3012 "create a swap partition with a label",
3014 Create a swap partition on C<device> with label C<label>.
3016 Note that you cannot attach a swap label to a block device
3017 (eg. C</dev/sda>), just to a partition. This appears to be
3018 a limitation of the kernel or swap tools.");
3020 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3021 (let uuid = uuidgen () in
3022 [InitEmpty, Always, TestRun (
3023 [["part_disk"; "/dev/sda"; "mbr"];
3024 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3025 "create a swap partition with an explicit UUID",
3027 Create a swap partition on C<device> with UUID C<uuid>.");
3029 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3030 [InitBasicFS, Always, TestOutputStruct (
3031 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3032 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3033 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3034 InitBasicFS, Always, TestOutputStruct (
3035 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3036 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3037 "make block, character or FIFO devices",
3039 This call creates block or character special devices, or
3040 named pipes (FIFOs).
3042 The C<mode> parameter should be the mode, using the standard
3043 constants. C<devmajor> and C<devminor> are the
3044 device major and minor numbers, only used when creating block
3045 and character special devices.
3047 Note that, just like L<mknod(2)>, the mode must be bitwise
3048 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3049 just creates a regular file). These constants are
3050 available in the standard Linux header files, or you can use
3051 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3052 which are wrappers around this command which bitwise OR
3053 in the appropriate constant for you.
3055 The mode actually set is affected by the umask.");
3057 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3058 [InitBasicFS, Always, TestOutputStruct (
3059 [["mkfifo"; "0o777"; "/node"];
3060 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3061 "make FIFO (named pipe)",
3063 This call creates a FIFO (named pipe) called C<path> with
3064 mode C<mode>. It is just a convenient wrapper around
3067 The mode actually set is affected by the umask.");
3069 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3070 [InitBasicFS, Always, TestOutputStruct (
3071 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3072 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3073 "make block device node",
3075 This call creates a block device node called C<path> with
3076 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3077 It is just a convenient wrapper around C<guestfs_mknod>.
3079 The mode actually set is affected by the umask.");
3081 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3082 [InitBasicFS, Always, TestOutputStruct (
3083 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3084 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3085 "make char device node",
3087 This call creates a char device node called C<path> with
3088 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3089 It is just a convenient wrapper around C<guestfs_mknod>.
3091 The mode actually set is affected by the umask.");
3093 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3094 [InitEmpty, Always, TestOutputInt (
3095 [["umask"; "0o22"]], 0o22)],
3096 "set file mode creation mask (umask)",
3098 This function sets the mask used for creating new files and
3099 device nodes to C<mask & 0777>.
3101 Typical umask values would be C<022> which creates new files
3102 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3103 C<002> which creates new files with permissions like
3104 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3106 The default umask is C<022>. This is important because it
3107 means that directories and device nodes will be created with
3108 C<0644> or C<0755> mode even if you specify C<0777>.
3110 See also C<guestfs_get_umask>,
3111 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3113 This call returns the previous umask.");
3115 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3117 "read directories entries",
3119 This returns the list of directory entries in directory C<dir>.
3121 All entries in the directory are returned, including C<.> and
3122 C<..>. The entries are I<not> sorted, but returned in the same
3123 order as the underlying filesystem.
3125 Also this call returns basic file type information about each
3126 file. The C<ftyp> field will contain one of the following characters:
3164 The L<readdir(3)> call returned a C<d_type> field with an
3169 This function is primarily intended for use by programs. To
3170 get a simple list of names, use C<guestfs_ls>. To get a printable
3171 directory for human consumption, use C<guestfs_ll>.");
3173 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3175 "create partitions on a block device",
3177 This is a simplified interface to the C<guestfs_sfdisk>
3178 command, where partition sizes are specified in megabytes
3179 only (rounded to the nearest cylinder) and you don't need
3180 to specify the cyls, heads and sectors parameters which
3181 were rarely if ever used anyway.
3183 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3184 and C<guestfs_part_disk>");
3186 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3188 "determine file type inside a compressed file",
3190 This command runs C<file> after first decompressing C<path>
3193 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3195 Since 1.0.63, use C<guestfs_file> instead which can now
3196 process compressed files.");
3198 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3200 "list extended attributes of a file or directory",
3202 This call lists the extended attributes of the file or directory
3205 At the system call level, this is a combination of the
3206 L<listxattr(2)> and L<getxattr(2)> calls.
3208 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3210 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3212 "list extended attributes of a file or directory",
3214 This is the same as C<guestfs_getxattrs>, but if C<path>
3215 is a symbolic link, then it returns the extended attributes
3216 of the link itself.");
3218 ("setxattr", (RErr, [String "xattr";
3219 String "val"; Int "vallen"; (* will be BufferIn *)
3220 Pathname "path"]), 143, [Optional "linuxxattrs"],
3222 "set extended attribute of a file or directory",
3224 This call sets the extended attribute named C<xattr>
3225 of the file C<path> to the value C<val> (of length C<vallen>).
3226 The value is arbitrary 8 bit data.
3228 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3230 ("lsetxattr", (RErr, [String "xattr";
3231 String "val"; Int "vallen"; (* will be BufferIn *)
3232 Pathname "path"]), 144, [Optional "linuxxattrs"],
3234 "set extended attribute of a file or directory",
3236 This is the same as C<guestfs_setxattr>, but if C<path>
3237 is a symbolic link, then it sets an extended attribute
3238 of the link itself.");
3240 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3242 "remove extended attribute of a file or directory",
3244 This call removes the extended attribute named C<xattr>
3245 of the file C<path>.
3247 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3249 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3251 "remove extended attribute of a file or directory",
3253 This is the same as C<guestfs_removexattr>, but if C<path>
3254 is a symbolic link, then it removes an extended attribute
3255 of the link itself.");
3257 ("mountpoints", (RHashtable "mps", []), 147, [],
3261 This call is similar to C<guestfs_mounts>. That call returns
3262 a list of devices. This one returns a hash table (map) of
3263 device name to directory where the device is mounted.");
3265 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3266 (* This is a special case: while you would expect a parameter
3267 * of type "Pathname", that doesn't work, because it implies
3268 * NEED_ROOT in the generated calling code in stubs.c, and
3269 * this function cannot use NEED_ROOT.
3272 "create a mountpoint",
3274 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3275 specialized calls that can be used to create extra mountpoints
3276 before mounting the first filesystem.
3278 These calls are I<only> necessary in some very limited circumstances,
3279 mainly the case where you want to mount a mix of unrelated and/or
3280 read-only filesystems together.
3282 For example, live CDs often contain a \"Russian doll\" nest of
3283 filesystems, an ISO outer layer, with a squashfs image inside, with
3284 an ext2/3 image inside that. You can unpack this as follows
3287 add-ro Fedora-11-i686-Live.iso
3290 mkmountpoint /squash
3293 mount-loop /cd/LiveOS/squashfs.img /squash
3294 mount-loop /squash/LiveOS/ext3fs.img /ext3
3296 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3298 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3300 "remove a mountpoint",
3302 This calls removes a mountpoint that was previously created
3303 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3304 for full details.");
3306 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3307 [InitISOFS, Always, TestOutputBuffer (
3308 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3309 (* Test various near large, large and too large files (RHBZ#589039). *)
3310 InitBasicFS, Always, TestLastFail (
3312 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3313 ["read_file"; "/a"]]);
3314 InitBasicFS, Always, TestLastFail (
3316 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3317 ["read_file"; "/a"]]);
3318 InitBasicFS, Always, TestLastFail (
3320 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3321 ["read_file"; "/a"]])],
3324 This calls returns the contents of the file C<path> as a
3327 Unlike C<guestfs_cat>, this function can correctly
3328 handle files that contain embedded ASCII NUL characters.
3329 However unlike C<guestfs_download>, this function is limited
3330 in the total size of file that can be handled.");
3332 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3333 [InitISOFS, Always, TestOutputList (
3334 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3335 InitISOFS, Always, TestOutputList (
3336 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3337 (* Test for RHBZ#579608, absolute symbolic links. *)
3338 InitISOFS, Always, TestOutputList (
3339 [["grep"; "nomatch"; "/abssymlink"]], [])],
3340 "return lines matching a pattern",
3342 This calls the external C<grep> program and returns the
3345 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3346 [InitISOFS, Always, TestOutputList (
3347 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3348 "return lines matching a pattern",
3350 This calls the external C<egrep> program and returns the
3353 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3354 [InitISOFS, Always, TestOutputList (
3355 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3356 "return lines matching a pattern",
3358 This calls the external C<fgrep> program and returns the
3361 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3362 [InitISOFS, Always, TestOutputList (
3363 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3364 "return lines matching a pattern",
3366 This calls the external C<grep -i> program and returns the
3369 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3370 [InitISOFS, Always, TestOutputList (
3371 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3372 "return lines matching a pattern",
3374 This calls the external C<egrep -i> program and returns the
3377 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3378 [InitISOFS, Always, TestOutputList (
3379 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3380 "return lines matching a pattern",
3382 This calls the external C<fgrep -i> program and returns the
3385 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3386 [InitISOFS, Always, TestOutputList (
3387 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3388 "return lines matching a pattern",
3390 This calls the external C<zgrep> program and returns the
3393 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3394 [InitISOFS, Always, TestOutputList (
3395 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3396 "return lines matching a pattern",
3398 This calls the external C<zegrep> program and returns the
3401 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3402 [InitISOFS, Always, TestOutputList (
3403 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3404 "return lines matching a pattern",
3406 This calls the external C<zfgrep> program and returns the
3409 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3410 [InitISOFS, Always, TestOutputList (
3411 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3412 "return lines matching a pattern",
3414 This calls the external C<zgrep -i> program and returns the
3417 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3418 [InitISOFS, Always, TestOutputList (
3419 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3420 "return lines matching a pattern",
3422 This calls the external C<zegrep -i> program and returns the
3425 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3426 [InitISOFS, Always, TestOutputList (
3427 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3428 "return lines matching a pattern",
3430 This calls the external C<zfgrep -i> program and returns the
3433 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3434 [InitISOFS, Always, TestOutput (
3435 [["realpath"; "/../directory"]], "/directory")],
3436 "canonicalized absolute pathname",
3438 Return the canonicalized absolute pathname of C<path>. The
3439 returned path has no C<.>, C<..> or symbolic link path elements.");
3441 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3442 [InitBasicFS, Always, TestOutputStruct (
3445 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3446 "create a hard link",
3448 This command creates a hard link using the C<ln> command.");
3450 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3451 [InitBasicFS, Always, TestOutputStruct (
3454 ["ln_f"; "/a"; "/b"];
3455 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3456 "create a hard link",
3458 This command creates a hard link using the C<ln -f> command.
3459 The C<-f> option removes the link (C<linkname>) if it exists already.");
3461 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3462 [InitBasicFS, Always, TestOutputStruct (
3464 ["ln_s"; "a"; "/b"];
3465 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3466 "create a symbolic link",
3468 This command creates a symbolic link using the C<ln -s> command.");
3470 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3471 [InitBasicFS, Always, TestOutput (
3472 [["mkdir_p"; "/a/b"];
3473 ["touch"; "/a/b/c"];
3474 ["ln_sf"; "../d"; "/a/b/c"];
3475 ["readlink"; "/a/b/c"]], "../d")],
3476 "create a symbolic link",
3478 This command creates a symbolic link using the C<ln -sf> command,
3479 The C<-f> option removes the link (C<linkname>) if it exists already.");
3481 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3482 [] (* XXX tested above *),
3483 "read the target of a symbolic link",
3485 This command reads the target of a symbolic link.");
3487 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3488 [InitBasicFS, Always, TestOutputStruct (
3489 [["fallocate"; "/a"; "1000000"];
3490 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3491 "preallocate a file in the guest filesystem",
3493 This command preallocates a file (containing zero bytes) named
3494 C<path> of size C<len> bytes. If the file exists already, it
3497 Do not confuse this with the guestfish-specific
3498 C<alloc> command which allocates a file in the host and
3499 attaches it as a device.");
3501 ("swapon_device", (RErr, [Device "device"]), 170, [],
3502 [InitPartition, Always, TestRun (
3503 [["mkswap"; "/dev/sda1"];
3504 ["swapon_device"; "/dev/sda1"];
3505 ["swapoff_device"; "/dev/sda1"]])],
3506 "enable swap on device",
3508 This command enables the libguestfs appliance to use the
3509 swap device or partition named C<device>. The increased
3510 memory is made available for all commands, for example
3511 those run using C<guestfs_command> or C<guestfs_sh>.
3513 Note that you should not swap to existing guest swap
3514 partitions unless you know what you are doing. They may
3515 contain hibernation information, or other information that
3516 the guest doesn't want you to trash. You also risk leaking
3517 information about the host to the guest this way. Instead,
3518 attach a new host device to the guest and swap on that.");
3520 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3521 [], (* XXX tested by swapon_device *)
3522 "disable swap on device",
3524 This command disables the libguestfs appliance swap
3525 device or partition named C<device>.
3526 See C<guestfs_swapon_device>.");
3528 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3529 [InitBasicFS, Always, TestRun (
3530 [["fallocate"; "/swap"; "8388608"];
3531 ["mkswap_file"; "/swap"];
3532 ["swapon_file"; "/swap"];
3533 ["swapoff_file"; "/swap"]])],
3534 "enable swap on file",
3536 This command enables swap to a file.
3537 See C<guestfs_swapon_device> for other notes.");
3539 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3540 [], (* XXX tested by swapon_file *)
3541 "disable swap on file",
3543 This command disables the libguestfs appliance swap on file.");
3545 ("swapon_label", (RErr, [String "label"]), 174, [],
3546 [InitEmpty, Always, TestRun (
3547 [["part_disk"; "/dev/sdb"; "mbr"];
3548 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3549 ["swapon_label"; "swapit"];
3550 ["swapoff_label"; "swapit"];
3551 ["zero"; "/dev/sdb"];
3552 ["blockdev_rereadpt"; "/dev/sdb"]])],
3553 "enable swap on labeled swap partition",
3555 This command enables swap to a labeled swap partition.
3556 See C<guestfs_swapon_device> for other notes.");
3558 ("swapoff_label", (RErr, [String "label"]), 175, [],
3559 [], (* XXX tested by swapon_label *)
3560 "disable swap on labeled swap partition",
3562 This command disables the libguestfs appliance swap on
3563 labeled swap partition.");
3565 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3566 (let uuid = uuidgen () in
3567 [InitEmpty, Always, TestRun (
3568 [["mkswap_U"; uuid; "/dev/sdb"];
3569 ["swapon_uuid"; uuid];
3570 ["swapoff_uuid"; uuid]])]),
3571 "enable swap on swap partition by UUID",
3573 This command enables swap to a swap partition with the given UUID.
3574 See C<guestfs_swapon_device> for other notes.");
3576 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3577 [], (* XXX tested by swapon_uuid *)
3578 "disable swap on swap partition by UUID",
3580 This command disables the libguestfs appliance swap partition
3581 with the given UUID.");
3583 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3584 [InitBasicFS, Always, TestRun (
3585 [["fallocate"; "/swap"; "8388608"];
3586 ["mkswap_file"; "/swap"]])],
3587 "create a swap file",
3591 This command just writes a swap file signature to an existing
3592 file. To create the file itself, use something like C<guestfs_fallocate>.");
3594 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3595 [InitISOFS, Always, TestRun (
3596 [["inotify_init"; "0"]])],
3597 "create an inotify handle",
3599 This command creates a new inotify handle.
3600 The inotify subsystem can be used to notify events which happen to
3601 objects in the guest filesystem.
3603 C<maxevents> is the maximum number of events which will be
3604 queued up between calls to C<guestfs_inotify_read> or
3605 C<guestfs_inotify_files>.
3606 If this is passed as C<0>, then the kernel (or previously set)
3607 default is used. For Linux 2.6.29 the default was 16384 events.
3608 Beyond this limit, the kernel throws away events, but records
3609 the fact that it threw them away by setting a flag
3610 C<IN_Q_OVERFLOW> in the returned structure list (see
3611 C<guestfs_inotify_read>).
3613 Before any events are generated, you have to add some
3614 watches to the internal watch list. See:
3615 C<guestfs_inotify_add_watch>,
3616 C<guestfs_inotify_rm_watch> and
3617 C<guestfs_inotify_watch_all>.
3619 Queued up events should be read periodically by calling
3620 C<guestfs_inotify_read>
3621 (or C<guestfs_inotify_files> which is just a helpful
3622 wrapper around C<guestfs_inotify_read>). If you don't
3623 read the events out often enough then you risk the internal
3626 The handle should be closed after use by calling
3627 C<guestfs_inotify_close>. This also removes any
3628 watches automatically.
3630 See also L<inotify(7)> for an overview of the inotify interface
3631 as exposed by the Linux kernel, which is roughly what we expose
3632 via libguestfs. Note that there is one global inotify handle
3633 per libguestfs instance.");
3635 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3636 [InitBasicFS, Always, TestOutputList (
3637 [["inotify_init"; "0"];
3638 ["inotify_add_watch"; "/"; "1073741823"];
3641 ["inotify_files"]], ["a"; "b"])],
3642 "add an inotify watch",
3644 Watch C<path> for the events listed in C<mask>.
3646 Note that if C<path> is a directory then events within that
3647 directory are watched, but this does I<not> happen recursively
3648 (in subdirectories).
3650 Note for non-C or non-Linux callers: the inotify events are
3651 defined by the Linux kernel ABI and are listed in
3652 C</usr/include/sys/inotify.h>.");
3654 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3656 "remove an inotify watch",
3658 Remove a previously defined inotify watch.
3659 See C<guestfs_inotify_add_watch>.");
3661 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3663 "return list of inotify events",
3665 Return the complete queue of events that have happened
3666 since the previous read call.
3668 If no events have happened, this returns an empty list.
3670 I<Note>: In order to make sure that all events have been
3671 read, you must call this function repeatedly until it
3672 returns an empty list. The reason is that the call will
3673 read events up to the maximum appliance-to-host message
3674 size and leave remaining events in the queue.");
3676 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3678 "return list of watched files that had events",
3680 This function is a helpful wrapper around C<guestfs_inotify_read>
3681 which just returns a list of pathnames of objects that were
3682 touched. The returned pathnames are sorted and deduplicated.");
3684 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3686 "close the inotify handle",
3688 This closes the inotify handle which was previously
3689 opened by inotify_init. It removes all watches, throws
3690 away any pending events, and deallocates all resources.");
3692 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3694 "set SELinux security context",
3696 This sets the SELinux security context of the daemon
3697 to the string C<context>.
3699 See the documentation about SELINUX in L<guestfs(3)>.");
3701 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3703 "get SELinux security context",
3705 This gets the SELinux security context of the daemon.
3707 See the documentation about SELINUX in L<guestfs(3)>,
3708 and C<guestfs_setcon>");
3710 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3711 [InitEmpty, Always, TestOutput (
3712 [["part_disk"; "/dev/sda"; "mbr"];
3713 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3714 ["mount_options"; ""; "/dev/sda1"; "/"];
3715 ["write"; "/new"; "new file contents"];
3716 ["cat"; "/new"]], "new file contents")],
3717 "make a filesystem with block size",
3719 This call is similar to C<guestfs_mkfs>, but it allows you to
3720 control the block size of the resulting filesystem. Supported
3721 block sizes depend on the filesystem type, but typically they
3722 are C<1024>, C<2048> or C<4096> only.");
3724 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3725 [InitEmpty, Always, TestOutput (
3726 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3727 ["mke2journal"; "4096"; "/dev/sda1"];
3728 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3729 ["mount_options"; ""; "/dev/sda2"; "/"];
3730 ["write"; "/new"; "new file contents"];
3731 ["cat"; "/new"]], "new file contents")],
3732 "make ext2/3/4 external journal",
3734 This creates an ext2 external journal on C<device>. It is equivalent
3737 mke2fs -O journal_dev -b blocksize device");
3739 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3740 [InitEmpty, Always, TestOutput (
3741 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3742 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3743 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3744 ["mount_options"; ""; "/dev/sda2"; "/"];
3745 ["write"; "/new"; "new file contents"];
3746 ["cat"; "/new"]], "new file contents")],
3747 "make ext2/3/4 external journal with label",
3749 This creates an ext2 external journal on C<device> with label C<label>.");
3751 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3752 (let uuid = uuidgen () in
3753 [InitEmpty, Always, TestOutput (
3754 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3755 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3756 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
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 UUID",
3762 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3764 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3766 "make ext2/3/4 filesystem with external journal",
3768 This creates an ext2/3/4 filesystem on C<device> with
3769 an external journal on C<journal>. It is equivalent
3772 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3774 See also C<guestfs_mke2journal>.");
3776 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3778 "make ext2/3/4 filesystem with external journal",
3780 This creates an ext2/3/4 filesystem on C<device> with
3781 an external journal on the journal labeled C<label>.
3783 See also C<guestfs_mke2journal_L>.");
3785 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3787 "make ext2/3/4 filesystem with external journal",
3789 This creates an ext2/3/4 filesystem on C<device> with
3790 an external journal on the journal with UUID C<uuid>.
3792 See also C<guestfs_mke2journal_U>.");
3794 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3795 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3796 "load a kernel module",
3798 This loads a kernel module in the appliance.
3800 The kernel module must have been whitelisted when libguestfs
3801 was built (see C<appliance/kmod.whitelist.in> in the source).");
3803 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3804 [InitNone, Always, TestOutput (
3805 [["echo_daemon"; "This is a test"]], "This is a test"
3807 "echo arguments back to the client",
3809 This command concatenates the list of C<words> passed with single spaces
3810 between them and returns the resulting string.
3812 You can use this command to test the connection through to the daemon.
3814 See also C<guestfs_ping_daemon>.");
3816 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3817 [], (* There is a regression test for this. *)
3818 "find all files and directories, returning NUL-separated list",
3820 This command lists out all files and directories, recursively,
3821 starting at C<directory>, placing the resulting list in the
3822 external file called C<files>.
3824 This command works the same way as C<guestfs_find> with the
3825 following exceptions:
3831 The resulting list is written to an external file.
3835 Items (filenames) in the result are separated
3836 by C<\\0> characters. See L<find(1)> option I<-print0>.
3840 This command is not limited in the number of names that it
3845 The result list is not sorted.
3849 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3850 [InitISOFS, Always, TestOutput (
3851 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3852 InitISOFS, Always, TestOutput (
3853 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3854 InitISOFS, Always, TestOutput (
3855 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3856 InitISOFS, Always, TestLastFail (
3857 [["case_sensitive_path"; "/Known-1/"]]);
3858 InitBasicFS, Always, TestOutput (
3860 ["mkdir"; "/a/bbb"];
3861 ["touch"; "/a/bbb/c"];
3862 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3863 InitBasicFS, Always, TestOutput (
3865 ["mkdir"; "/a/bbb"];
3866 ["touch"; "/a/bbb/c"];
3867 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3868 InitBasicFS, Always, TestLastFail (
3870 ["mkdir"; "/a/bbb"];
3871 ["touch"; "/a/bbb/c"];
3872 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3873 "return true path on case-insensitive filesystem",
3875 This can be used to resolve case insensitive paths on
3876 a filesystem which is case sensitive. The use case is
3877 to resolve paths which you have read from Windows configuration
3878 files or the Windows Registry, to the true path.
3880 The command handles a peculiarity of the Linux ntfs-3g
3881 filesystem driver (and probably others), which is that although
3882 the underlying filesystem is case-insensitive, the driver
3883 exports the filesystem to Linux as case-sensitive.
3885 One consequence of this is that special directories such
3886 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3887 (or other things) depending on the precise details of how
3888 they were created. In Windows itself this would not be
3891 Bug or feature? You decide:
3892 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3894 This function resolves the true case of each element in the
3895 path and returns the case-sensitive path.
3897 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3898 might return C<\"/WINDOWS/system32\"> (the exact return value
3899 would depend on details of how the directories were originally
3900 created under Windows).
3903 This function does not handle drive names, backslashes etc.
3905 See also C<guestfs_realpath>.");
3907 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3908 [InitBasicFS, Always, TestOutput (
3909 [["vfs_type"; "/dev/sda1"]], "ext2")],
3910 "get the Linux VFS type corresponding to a mounted device",
3912 This command gets the filesystem type corresponding to
3913 the filesystem on C<device>.
3915 For most filesystems, the result is the name of the Linux
3916 VFS module which would be used to mount this filesystem
3917 if you mounted it without specifying the filesystem type.
3918 For example a string such as C<ext3> or C<ntfs>.");
3920 ("truncate", (RErr, [Pathname "path"]), 199, [],
3921 [InitBasicFS, Always, TestOutputStruct (
3922 [["write"; "/test"; "some stuff so size is not zero"];
3923 ["truncate"; "/test"];
3924 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3925 "truncate a file to zero size",
3927 This command truncates C<path> to a zero-length file. The
3928 file must exist already.");
3930 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3931 [InitBasicFS, Always, TestOutputStruct (
3932 [["touch"; "/test"];
3933 ["truncate_size"; "/test"; "1000"];
3934 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3935 "truncate a file to a particular size",
3937 This command truncates C<path> to size C<size> bytes. The file
3940 If the current file size is less than C<size> then
3941 the file is extended to the required size with zero bytes.
3942 This creates a sparse file (ie. disk blocks are not allocated
3943 for the file until you write to it). To create a non-sparse
3944 file of zeroes, use C<guestfs_fallocate64> instead.");
3946 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3947 [InitBasicFS, Always, TestOutputStruct (
3948 [["touch"; "/test"];
3949 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3950 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3951 "set timestamp of a file with nanosecond precision",
3953 This command sets the timestamps of a file with nanosecond
3956 C<atsecs, atnsecs> are the last access time (atime) in secs and
3957 nanoseconds from the epoch.
3959 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3960 secs and nanoseconds from the epoch.
3962 If the C<*nsecs> field contains the special value C<-1> then
3963 the corresponding timestamp is set to the current time. (The
3964 C<*secs> field is ignored in this case).
3966 If the C<*nsecs> field contains the special value C<-2> then
3967 the corresponding timestamp is left unchanged. (The
3968 C<*secs> field is ignored in this case).");
3970 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3971 [InitBasicFS, Always, TestOutputStruct (
3972 [["mkdir_mode"; "/test"; "0o111"];
3973 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3974 "create a directory with a particular mode",
3976 This command creates a directory, setting the initial permissions
3977 of the directory to C<mode>.
3979 For common Linux filesystems, the actual mode which is set will
3980 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
3981 interpret the mode in other ways.
3983 See also C<guestfs_mkdir>, C<guestfs_umask>");
3985 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3987 "change file owner and group",
3989 Change the file owner to C<owner> and group to C<group>.
3990 This is like C<guestfs_chown> but if C<path> is a symlink then
3991 the link itself is changed, not the target.
3993 Only numeric uid and gid are supported. If you want to use
3994 names, you will need to locate and parse the password file
3995 yourself (Augeas support makes this relatively easy).");
3997 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3999 "lstat on multiple files",
4001 This call allows you to perform the C<guestfs_lstat> operation
4002 on multiple files, where all files are in the directory C<path>.
4003 C<names> is the list of files from this directory.
4005 On return you get a list of stat structs, with a one-to-one
4006 correspondence to the C<names> list. If any name did not exist
4007 or could not be lstat'd, then the C<ino> field of that structure
4010 This call is intended for programs that want to efficiently
4011 list a directory contents without making many round-trips.
4012 See also C<guestfs_lxattrlist> for a similarly efficient call
4013 for getting extended attributes. Very long directory listings
4014 might cause the protocol message size to be exceeded, causing
4015 this call to fail. The caller must split up such requests
4016 into smaller groups of names.");
4018 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4020 "lgetxattr on multiple files",
4022 This call allows you to get the extended attributes
4023 of multiple files, where all files are in the directory C<path>.
4024 C<names> is the list of files from this directory.
4026 On return you get a flat list of xattr structs which must be
4027 interpreted sequentially. The first xattr struct always has a zero-length
4028 C<attrname>. C<attrval> in this struct is zero-length
4029 to indicate there was an error doing C<lgetxattr> for this
4030 file, I<or> is a C string which is a decimal number
4031 (the number of following attributes for this file, which could
4032 be C<\"0\">). Then after the first xattr struct are the
4033 zero or more attributes for the first named file.
4034 This repeats for the second and subsequent files.
4036 This call is intended for programs that want to efficiently
4037 list a directory contents without making many round-trips.
4038 See also C<guestfs_lstatlist> for a similarly efficient call
4039 for getting standard stats. Very long directory listings
4040 might cause the protocol message size to be exceeded, causing
4041 this call to fail. The caller must split up such requests
4042 into smaller groups of names.");
4044 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4046 "readlink on multiple files",
4048 This call allows you to do a C<readlink> operation
4049 on multiple files, where all files are in the directory C<path>.
4050 C<names> is the list of files from this directory.
4052 On return you get a list of strings, with a one-to-one
4053 correspondence to the C<names> list. Each string is the
4054 value of the symbolic link.
4056 If the C<readlink(2)> operation fails on any name, then
4057 the corresponding result string is the empty string C<\"\">.
4058 However the whole operation is completed even if there
4059 were C<readlink(2)> errors, and so you can call this
4060 function with names where you don't know if they are
4061 symbolic links already (albeit slightly less efficient).
4063 This call is intended for programs that want to efficiently
4064 list a directory contents without making many round-trips.
4065 Very long directory listings might cause the protocol
4066 message size to be exceeded, causing
4067 this call to fail. The caller must split up such requests
4068 into smaller groups of names.");
4070 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4071 [InitISOFS, Always, TestOutputBuffer (
4072 [["pread"; "/known-4"; "1"; "3"]], "\n");
4073 InitISOFS, Always, TestOutputBuffer (
4074 [["pread"; "/empty"; "0"; "100"]], "")],
4075 "read part of a file",
4077 This command lets you read part of a file. It reads C<count>
4078 bytes of the file, starting at C<offset>, from file C<path>.
4080 This may read fewer bytes than requested. For further details
4081 see the L<pread(2)> system call.
4083 See also C<guestfs_pwrite>.");
4085 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4086 [InitEmpty, Always, TestRun (
4087 [["part_init"; "/dev/sda"; "gpt"]])],
4088 "create an empty partition table",
4090 This creates an empty partition table on C<device> of one of the
4091 partition types listed below. Usually C<parttype> should be
4092 either C<msdos> or C<gpt> (for large disks).
4094 Initially there are no partitions. Following this, you should
4095 call C<guestfs_part_add> for each partition required.
4097 Possible values for C<parttype> are:
4101 =item B<efi> | B<gpt>
4103 Intel EFI / GPT partition table.
4105 This is recommended for >= 2 TB partitions that will be accessed
4106 from Linux and Intel-based Mac OS X. It also has limited backwards
4107 compatibility with the C<mbr> format.
4109 =item B<mbr> | B<msdos>
4111 The standard PC \"Master Boot Record\" (MBR) format used
4112 by MS-DOS and Windows. This partition type will B<only> work
4113 for device sizes up to 2 TB. For large disks we recommend
4118 Other partition table types that may work but are not
4127 =item B<amiga> | B<rdb>
4129 Amiga \"Rigid Disk Block\" format.
4137 DASD, used on IBM mainframes.
4145 Old Mac partition format. Modern Macs use C<gpt>.
4149 NEC PC-98 format, common in Japan apparently.
4157 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4158 [InitEmpty, Always, TestRun (
4159 [["part_init"; "/dev/sda"; "mbr"];
4160 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4161 InitEmpty, Always, TestRun (
4162 [["part_init"; "/dev/sda"; "gpt"];
4163 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4164 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4165 InitEmpty, Always, TestRun (
4166 [["part_init"; "/dev/sda"; "mbr"];
4167 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4168 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4169 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4170 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4171 "add a partition to the device",
4173 This command adds a partition to C<device>. If there is no partition
4174 table on the device, call C<guestfs_part_init> first.
4176 The C<prlogex> parameter is the type of partition. Normally you
4177 should pass C<p> or C<primary> here, but MBR partition tables also
4178 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4181 C<startsect> and C<endsect> are the start and end of the partition
4182 in I<sectors>. C<endsect> may be negative, which means it counts
4183 backwards from the end of the disk (C<-1> is the last sector).
4185 Creating a partition which covers the whole disk is not so easy.
4186 Use C<guestfs_part_disk> to do that.");
4188 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4189 [InitEmpty, Always, TestRun (
4190 [["part_disk"; "/dev/sda"; "mbr"]]);
4191 InitEmpty, Always, TestRun (
4192 [["part_disk"; "/dev/sda"; "gpt"]])],
4193 "partition whole disk with a single primary partition",
4195 This command is simply a combination of C<guestfs_part_init>
4196 followed by C<guestfs_part_add> to create a single primary partition
4197 covering the whole disk.
4199 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4200 but other possible values are described in C<guestfs_part_init>.");
4202 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4203 [InitEmpty, Always, TestRun (
4204 [["part_disk"; "/dev/sda"; "mbr"];
4205 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4206 "make a partition bootable",
4208 This sets the bootable flag on partition numbered C<partnum> on
4209 device C<device>. Note that partitions are numbered from 1.
4211 The bootable flag is used by some operating systems (notably
4212 Windows) to determine which partition to boot from. It is by
4213 no means universally recognized.");
4215 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4216 [InitEmpty, Always, TestRun (
4217 [["part_disk"; "/dev/sda"; "gpt"];
4218 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4219 "set partition name",
4221 This sets the partition name on partition numbered C<partnum> on
4222 device C<device>. Note that partitions are numbered from 1.
4224 The partition name can only be set on certain types of partition
4225 table. This works on C<gpt> but not on C<mbr> partitions.");
4227 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4228 [], (* XXX Add a regression test for this. *)
4229 "list partitions on a device",
4231 This command parses the partition table on C<device> and
4232 returns the list of partitions found.
4234 The fields in the returned structure are:
4240 Partition number, counting from 1.
4244 Start of the partition I<in bytes>. To get sectors you have to
4245 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4249 End of the partition in bytes.
4253 Size of the partition in bytes.
4257 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4258 [InitEmpty, Always, TestOutput (
4259 [["part_disk"; "/dev/sda"; "gpt"];
4260 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4261 "get the partition table type",
4263 This command examines the partition table on C<device> and
4264 returns the partition table type (format) being used.
4266 Common return values include: C<msdos> (a DOS/Windows style MBR
4267 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4268 values are possible, although unusual. See C<guestfs_part_init>
4271 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4272 [InitBasicFS, Always, TestOutputBuffer (
4273 [["fill"; "0x63"; "10"; "/test"];
4274 ["read_file"; "/test"]], "cccccccccc")],
4275 "fill a file with octets",
4277 This command creates a new file called C<path>. The initial
4278 content of the file is C<len> octets of C<c>, where C<c>
4279 must be a number in the range C<[0..255]>.
4281 To fill a file with zero bytes (sparsely), it is
4282 much more efficient to use C<guestfs_truncate_size>.
4283 To create a file with a pattern of repeating bytes
4284 use C<guestfs_fill_pattern>.");
4286 ("available", (RErr, [StringList "groups"]), 216, [],
4287 [InitNone, Always, TestRun [["available"; ""]]],
4288 "test availability of some parts of the API",
4290 This command is used to check the availability of some
4291 groups of functionality in the appliance, which not all builds of
4292 the libguestfs appliance will be able to provide.
4294 The libguestfs groups, and the functions that those
4295 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4296 You can also fetch this list at runtime by calling
4297 C<guestfs_available_all_groups>.
4299 The argument C<groups> is a list of group names, eg:
4300 C<[\"inotify\", \"augeas\"]> would check for the availability of
4301 the Linux inotify functions and Augeas (configuration file
4304 The command returns no error if I<all> requested groups are available.
4306 It fails with an error if one or more of the requested
4307 groups is unavailable in the appliance.
4309 If an unknown group name is included in the
4310 list of groups then an error is always returned.
4318 You must call C<guestfs_launch> before calling this function.
4320 The reason is because we don't know what groups are
4321 supported by the appliance/daemon until it is running and can
4326 If a group of functions is available, this does not necessarily
4327 mean that they will work. You still have to check for errors
4328 when calling individual API functions even if they are
4333 It is usually the job of distro packagers to build
4334 complete functionality into the libguestfs appliance.
4335 Upstream libguestfs, if built from source with all
4336 requirements satisfied, will support everything.
4340 This call was added in version C<1.0.80>. In previous
4341 versions of libguestfs all you could do would be to speculatively
4342 execute a command to find out if the daemon implemented it.
4343 See also C<guestfs_version>.
4347 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4348 [InitBasicFS, Always, TestOutputBuffer (
4349 [["write"; "/src"; "hello, world"];
4350 ["dd"; "/src"; "/dest"];
4351 ["read_file"; "/dest"]], "hello, world")],
4352 "copy from source to destination using dd",
4354 This command copies from one source device or file C<src>
4355 to another destination device or file C<dest>. Normally you
4356 would use this to copy to or from a device or partition, for
4357 example to duplicate a filesystem.
4359 If the destination is a device, it must be as large or larger
4360 than the source file or device, otherwise the copy will fail.
4361 This command cannot do partial copies (see C<guestfs_copy_size>).");
4363 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4364 [InitBasicFS, Always, TestOutputInt (
4365 [["write"; "/file"; "hello, world"];
4366 ["filesize"; "/file"]], 12)],
4367 "return the size of the file in bytes",
4369 This command returns the size of C<file> in bytes.
4371 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4372 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4373 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4375 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4376 [InitBasicFSonLVM, Always, TestOutputList (
4377 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4378 ["lvs"]], ["/dev/VG/LV2"])],
4379 "rename an LVM logical volume",
4381 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4383 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4384 [InitBasicFSonLVM, Always, TestOutputList (
4386 ["vg_activate"; "false"; "VG"];
4387 ["vgrename"; "VG"; "VG2"];
4388 ["vg_activate"; "true"; "VG2"];
4389 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4390 ["vgs"]], ["VG2"])],
4391 "rename an LVM volume group",
4393 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4395 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4396 [InitISOFS, Always, TestOutputBuffer (
4397 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4398 "list the contents of a single file in an initrd",
4400 This command unpacks the file C<filename> from the initrd file
4401 called C<initrdpath>. The filename must be given I<without> the
4402 initial C</> character.
4404 For example, in guestfish you could use the following command
4405 to examine the boot script (usually called C</init>)
4406 contained in a Linux initrd or initramfs image:
4408 initrd-cat /boot/initrd-<version>.img init
4410 See also C<guestfs_initrd_list>.");
4412 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4414 "get the UUID of a physical volume",
4416 This command returns the UUID of the LVM PV C<device>.");
4418 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4420 "get the UUID of a volume group",
4422 This command returns the UUID of the LVM VG named C<vgname>.");
4424 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4426 "get the UUID of a logical volume",
4428 This command returns the UUID of the LVM LV C<device>.");
4430 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4432 "get the PV UUIDs containing the volume group",
4434 Given a VG called C<vgname>, this returns the UUIDs of all
4435 the physical volumes that this volume group resides on.
4437 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4438 calls to associate physical volumes and volume groups.
4440 See also C<guestfs_vglvuuids>.");
4442 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4444 "get the LV UUIDs of all LVs in the volume group",
4446 Given a VG called C<vgname>, this returns the UUIDs of all
4447 the logical volumes created in this volume group.
4449 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4450 calls to associate logical volumes and volume groups.
4452 See also C<guestfs_vgpvuuids>.");
4454 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4455 [InitBasicFS, Always, TestOutputBuffer (
4456 [["write"; "/src"; "hello, world"];
4457 ["copy_size"; "/src"; "/dest"; "5"];
4458 ["read_file"; "/dest"]], "hello")],
4459 "copy size bytes from source to destination using dd",
4461 This command copies exactly C<size> bytes from one source device
4462 or file C<src> to another destination device or file C<dest>.
4464 Note this will fail if the source is too short or if the destination
4465 is not large enough.");
4467 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4468 [InitBasicFSonLVM, Always, TestRun (
4469 [["zero_device"; "/dev/VG/LV"]])],
4470 "write zeroes to an entire device",
4472 This command writes zeroes over the entire C<device>. Compare
4473 with C<guestfs_zero> which just zeroes the first few blocks of
4476 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [Optional "xz"],
4477 [InitBasicFS, Always, TestOutput (
4478 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4479 ["cat"; "/hello"]], "hello\n")],
4480 "unpack compressed tarball to directory",
4482 This command uploads and unpacks local file C<tarball> (an
4483 I<xz compressed> tar file) into C<directory>.");
4485 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [Optional "xz"],
4487 "pack directory into compressed tarball",
4489 This command packs the contents of C<directory> and downloads
4490 it to local file C<tarball> (as an xz compressed tar archive).");
4492 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4494 "resize an NTFS filesystem",
4496 This command resizes an NTFS filesystem, expanding or
4497 shrinking it to the size of the underlying device.
4498 See also L<ntfsresize(8)>.");
4500 ("vgscan", (RErr, []), 232, [],
4501 [InitEmpty, Always, TestRun (
4503 "rescan for LVM physical volumes, volume groups and logical volumes",
4505 This rescans all block devices and rebuilds the list of LVM
4506 physical volumes, volume groups and logical volumes.");
4508 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4509 [InitEmpty, Always, TestRun (
4510 [["part_init"; "/dev/sda"; "mbr"];
4511 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4512 ["part_del"; "/dev/sda"; "1"]])],
4513 "delete a partition",
4515 This command deletes the partition numbered C<partnum> on C<device>.
4517 Note that in the case of MBR partitioning, deleting an
4518 extended partition also deletes any logical partitions
4521 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4522 [InitEmpty, Always, TestOutputTrue (
4523 [["part_init"; "/dev/sda"; "mbr"];
4524 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4525 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4526 ["part_get_bootable"; "/dev/sda"; "1"]])],
4527 "return true if a partition is bootable",
4529 This command returns true if the partition C<partnum> on
4530 C<device> has the bootable flag set.
4532 See also C<guestfs_part_set_bootable>.");
4534 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4535 [InitEmpty, Always, TestOutputInt (
4536 [["part_init"; "/dev/sda"; "mbr"];
4537 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4538 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4539 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4540 "get the MBR type byte (ID byte) from a partition",
4542 Returns the MBR type byte (also known as the ID byte) from
4543 the numbered partition C<partnum>.
4545 Note that only MBR (old DOS-style) partitions have type bytes.
4546 You will get undefined results for other partition table
4547 types (see C<guestfs_part_get_parttype>).");
4549 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4550 [], (* tested by part_get_mbr_id *)
4551 "set the MBR type byte (ID byte) of a partition",
4553 Sets the MBR type byte (also known as the ID byte) of
4554 the numbered partition C<partnum> to C<idbyte>. Note
4555 that the type bytes quoted in most documentation are
4556 in fact hexadecimal numbers, but usually documented
4557 without any leading \"0x\" which might be confusing.
4559 Note that only MBR (old DOS-style) partitions have type bytes.
4560 You will get undefined results for other partition table
4561 types (see C<guestfs_part_get_parttype>).");
4563 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4564 [InitISOFS, Always, TestOutput (
4565 [["checksum_device"; "md5"; "/dev/sdd"]],
4566 (Digest.to_hex (Digest.file "images/test.iso")))],
4567 "compute MD5, SHAx or CRC checksum of the contents of a device",
4569 This call computes the MD5, SHAx or CRC checksum of the
4570 contents of the device named C<device>. For the types of
4571 checksums supported see the C<guestfs_checksum> command.");
4573 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4574 [InitNone, Always, TestRun (
4575 [["part_disk"; "/dev/sda"; "mbr"];
4576 ["pvcreate"; "/dev/sda1"];
4577 ["vgcreate"; "VG"; "/dev/sda1"];
4578 ["lvcreate"; "LV"; "VG"; "10"];
4579 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4580 "expand an LV to fill free space",
4582 This expands an existing logical volume C<lv> so that it fills
4583 C<pc>% of the remaining free space in the volume group. Commonly
4584 you would call this with pc = 100 which expands the logical volume
4585 as much as possible, using all remaining free space in the volume
4588 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4589 [], (* XXX Augeas code needs tests. *)
4590 "clear Augeas path",
4592 Set the value associated with C<path> to C<NULL>. This
4593 is the same as the L<augtool(1)> C<clear> command.");
4595 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
4596 [InitEmpty, Always, TestOutputInt (
4597 [["get_umask"]], 0o22)],
4598 "get the current umask",
4600 Return the current umask. By default the umask is C<022>
4601 unless it has been set by calling C<guestfs_umask>.");
4603 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
4605 "upload a file to the appliance (internal use only)",
4607 The C<guestfs_debug_upload> command uploads a file to
4608 the libguestfs appliance.
4610 There is no comprehensive help for this command. You have
4611 to look at the file C<daemon/debug.c> in the libguestfs source
4612 to find out what it is for.");
4614 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
4615 [InitBasicFS, Always, TestOutput (
4616 [["base64_in"; "../images/hello.b64"; "/hello"];
4617 ["cat"; "/hello"]], "hello\n")],
4618 "upload base64-encoded data to file",
4620 This command uploads base64-encoded data from C<base64file>
4623 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
4625 "download file and encode as base64",
4627 This command downloads the contents of C<filename>, writing
4628 it out to local file C<base64file> encoded as base64.");
4630 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
4632 "compute MD5, SHAx or CRC checksum of files in a directory",
4634 This command computes the checksums of all regular files in
4635 C<directory> and then emits a list of those checksums to
4636 the local output file C<sumsfile>.
4638 This can be used for verifying the integrity of a virtual
4639 machine. However to be properly secure you should pay
4640 attention to the output of the checksum command (it uses
4641 the ones from GNU coreutils). In particular when the
4642 filename is not printable, coreutils uses a special
4643 backslash syntax. For more information, see the GNU
4644 coreutils info file.");
4646 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
4647 [InitBasicFS, Always, TestOutputBuffer (
4648 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4649 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4650 "fill a file with a repeating pattern of bytes",
4652 This function is like C<guestfs_fill> except that it creates
4653 a new file of length C<len> containing the repeating pattern
4654 of bytes in C<pattern>. The pattern is truncated if necessary
4655 to ensure the length of the file is exactly C<len> bytes.");
4657 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
4658 [InitBasicFS, Always, TestOutput (
4659 [["write"; "/new"; "new file contents"];
4660 ["cat"; "/new"]], "new file contents");
4661 InitBasicFS, Always, TestOutput (
4662 [["write"; "/new"; "\nnew file contents\n"];
4663 ["cat"; "/new"]], "\nnew file contents\n");
4664 InitBasicFS, Always, TestOutput (
4665 [["write"; "/new"; "\n\n"];
4666 ["cat"; "/new"]], "\n\n");
4667 InitBasicFS, Always, TestOutput (
4668 [["write"; "/new"; ""];
4669 ["cat"; "/new"]], "");
4670 InitBasicFS, Always, TestOutput (
4671 [["write"; "/new"; "\n\n\n"];
4672 ["cat"; "/new"]], "\n\n\n");
4673 InitBasicFS, Always, TestOutput (
4674 [["write"; "/new"; "\n"];
4675 ["cat"; "/new"]], "\n")],
4676 "create a new file",
4678 This call creates a file called C<path>. The content of the
4679 file is the string C<content> (which can contain any 8 bit data).");
4681 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
4682 [InitBasicFS, Always, TestOutput (
4683 [["write"; "/new"; "new file contents"];
4684 ["pwrite"; "/new"; "data"; "4"];
4685 ["cat"; "/new"]], "new data contents");
4686 InitBasicFS, Always, TestOutput (
4687 [["write"; "/new"; "new file contents"];
4688 ["pwrite"; "/new"; "is extended"; "9"];
4689 ["cat"; "/new"]], "new file is extended");
4690 InitBasicFS, Always, TestOutput (
4691 [["write"; "/new"; "new file contents"];
4692 ["pwrite"; "/new"; ""; "4"];
4693 ["cat"; "/new"]], "new file contents")],
4694 "write to part of a file",
4696 This command writes to part of a file. It writes the data
4697 buffer C<content> to the file C<path> starting at offset C<offset>.
4699 This command implements the L<pwrite(2)> system call, and like
4700 that system call it may not write the full data requested. The
4701 return value is the number of bytes that were actually written
4702 to the file. This could even be 0, although short writes are
4703 unlikely for regular files in ordinary circumstances.
4705 See also C<guestfs_pread>.");
4707 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
4709 "resize an ext2/ext3 filesystem (with size)",
4711 This command is the same as C<guestfs_resize2fs> except that it
4712 allows you to specify the new size (in bytes) explicitly.");
4714 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
4716 "resize an LVM physical volume (with size)",
4718 This command is the same as C<guestfs_pvresize> except that it
4719 allows you to specify the new size (in bytes) explicitly.");
4721 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"]), 250, [Optional "ntfsprogs"],
4723 "resize an NTFS filesystem (with size)",
4725 This command is the same as C<guestfs_ntfsresize> except that it
4726 allows you to specify the new size (in bytes) explicitly.");
4728 ("available_all_groups", (RStringList "groups", []), 251, [],
4729 [InitNone, Always, TestRun [["available_all_groups"]]],
4730 "return a list of all optional groups",
4732 This command returns a list of all optional groups that this
4733 daemon knows about. Note this returns both supported and unsupported
4734 groups. To find out which ones the daemon can actually support
4735 you have to call C<guestfs_available> on each member of the
4738 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4740 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"]), 252, [],
4741 [InitBasicFS, Always, TestOutputStruct (
4742 [["fallocate64"; "/a"; "1000000"];
4743 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4744 "preallocate a file in the guest filesystem",
4746 This command preallocates a file (containing zero bytes) named
4747 C<path> of size C<len> bytes. If the file exists already, it
4750 Note that this call allocates disk blocks for the file.
4751 To create a sparse file use C<guestfs_truncate_size> instead.
4753 The deprecated call C<guestfs_fallocate> does the same,
4754 but owing to an oversight it only allowed 30 bit lengths
4755 to be specified, effectively limiting the maximum size
4756 of files created through that call to 1GB.
4758 Do not confuse this with the guestfish-specific
4759 C<alloc> and C<sparse> commands which create
4760 a file in the host and attach it as a device.");
4762 ("vfs_label", (RString "label", [Device "device"]), 253, [],
4763 [InitBasicFS, Always, TestOutput (
4764 [["set_e2label"; "/dev/sda1"; "LTEST"];
4765 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4766 "get the filesystem label",
4768 This returns the filesystem label of the filesystem on
4771 If the filesystem is unlabeled, this returns the empty string.");
4773 ("vfs_uuid", (RString "uuid", [Device "device"]), 254, [],
4774 (let uuid = uuidgen () in
4775 [InitBasicFS, Always, TestOutput (
4776 [["set_e2uuid"; "/dev/sda1"; uuid];
4777 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4778 "get the filesystem UUID",
4780 This returns the filesystem UUID of the filesystem on
4783 If the filesystem does not have a UUID, this returns the empty string.");
4787 let all_functions = non_daemon_functions @ daemon_functions
4789 (* In some places we want the functions to be displayed sorted
4790 * alphabetically, so this is useful:
4792 let all_functions_sorted =
4793 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4794 compare n1 n2) all_functions
4796 (* This is used to generate the src/MAX_PROC_NR file which
4797 * contains the maximum procedure number, a surrogate for the
4798 * ABI version number. See src/Makefile.am for the details.
4801 let proc_nrs = List.map (
4802 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4803 ) daemon_functions in
4804 List.fold_left max 0 proc_nrs
4806 (* Field types for structures. *)
4808 | FChar (* C 'char' (really, a 7 bit byte). *)
4809 | FString (* nul-terminated ASCII string, NOT NULL. *)
4810 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4815 | FBytes (* Any int measure that counts bytes. *)
4816 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4817 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4819 (* Because we generate extra parsing code for LVM command line tools,
4820 * we have to pull out the LVM columns separately here.
4830 "pv_attr", FString (* XXX *);
4831 "pv_pe_count", FInt64;
4832 "pv_pe_alloc_count", FInt64;
4835 "pv_mda_count", FInt64;
4836 "pv_mda_free", FBytes;
4837 (* Not in Fedora 10:
4838 "pv_mda_size", FBytes;
4845 "vg_attr", FString (* XXX *);
4848 "vg_sysid", FString;
4849 "vg_extent_size", FBytes;
4850 "vg_extent_count", FInt64;
4851 "vg_free_count", FInt64;
4856 "snap_count", FInt64;
4859 "vg_mda_count", FInt64;
4860 "vg_mda_free", FBytes;
4861 (* Not in Fedora 10:
4862 "vg_mda_size", FBytes;
4868 "lv_attr", FString (* XXX *);
4871 "lv_kernel_major", FInt64;
4872 "lv_kernel_minor", FInt64;
4874 "seg_count", FInt64;
4876 "snap_percent", FOptPercent;
4877 "copy_percent", FOptPercent;
4880 "mirror_log", FString;
4884 (* Names and fields in all structures (in RStruct and RStructList)
4888 (* The old RIntBool return type, only ever used for aug_defnode. Do
4889 * not use this struct in any new code.
4892 "i", FInt32; (* for historical compatibility *)
4893 "b", FInt32; (* for historical compatibility *)
4896 (* LVM PVs, VGs, LVs. *)
4897 "lvm_pv", lvm_pv_cols;
4898 "lvm_vg", lvm_vg_cols;
4899 "lvm_lv", lvm_lv_cols;
4901 (* Column names and types from stat structures.
4902 * NB. Can't use things like 'st_atime' because glibc header files
4903 * define some of these as macros. Ugh.
4934 (* Column names in dirent structure. *)
4937 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4942 (* Version numbers. *)
4950 (* Extended attribute. *)
4952 "attrname", FString;
4956 (* Inotify events. *)
4960 "in_cookie", FUInt32;
4964 (* Partition table entry. *)
4967 "part_start", FBytes;
4969 "part_size", FBytes;
4971 ] (* end of structs *)
4973 (* Ugh, Java has to be different ..
4974 * These names are also used by the Haskell bindings.
4976 let java_structs = [
4977 "int_bool", "IntBool";
4982 "statvfs", "StatVFS";
4984 "version", "Version";
4986 "inotify_event", "INotifyEvent";
4987 "partition", "Partition";
4990 (* What structs are actually returned. *)
4991 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4993 (* Returns a list of RStruct/RStructList structs that are returned
4994 * by any function. Each element of returned list is a pair:
4996 * (structname, RStructOnly)
4997 * == there exists function which returns RStruct (_, structname)
4998 * (structname, RStructListOnly)
4999 * == there exists function which returns RStructList (_, structname)
5000 * (structname, RStructAndList)
5001 * == there are functions returning both RStruct (_, structname)
5002 * and RStructList (_, structname)
5004 let rstructs_used_by functions =
5005 (* ||| is a "logical OR" for rstructs_used_t *)
5009 | _, RStructAndList -> RStructAndList
5010 | RStructOnly, RStructListOnly
5011 | RStructListOnly, RStructOnly -> RStructAndList
5012 | RStructOnly, RStructOnly -> RStructOnly
5013 | RStructListOnly, RStructListOnly -> RStructListOnly
5016 let h = Hashtbl.create 13 in
5018 (* if elem->oldv exists, update entry using ||| operator,
5019 * else just add elem->newv to the hash
5021 let update elem newv =
5022 try let oldv = Hashtbl.find h elem in
5023 Hashtbl.replace h elem (newv ||| oldv)
5024 with Not_found -> Hashtbl.add h elem newv
5028 fun (_, style, _, _, _, _, _) ->
5029 match fst style with
5030 | RStruct (_, structname) -> update structname RStructOnly
5031 | RStructList (_, structname) -> update structname RStructListOnly
5035 (* return key->values as a list of (key,value) *)
5036 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
5038 (* Used for testing language bindings. *)
5040 | CallString of string
5041 | CallOptString of string option
5042 | CallStringList of string list
5044 | CallInt64 of int64
5046 | CallBuffer of string
5048 (* Used to memoize the result of pod2text. *)
5049 let pod2text_memo_filename = "src/.pod2text.data"
5050 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
5052 let chan = open_in pod2text_memo_filename in
5053 let v = input_value chan in
5057 _ -> Hashtbl.create 13
5058 let pod2text_memo_updated () =
5059 let chan = open_out pod2text_memo_filename in
5060 output_value chan pod2text_memo;
5063 (* Useful functions.
5064 * Note we don't want to use any external OCaml libraries which
5065 * makes this a bit harder than it should be.
5067 module StringMap = Map.Make (String)
5069 let failwithf fs = ksprintf failwith fs
5071 let unique = let i = ref 0 in fun () -> incr i; !i
5073 let replace_char s c1 c2 =
5074 let s2 = String.copy s in
5075 let r = ref false in
5076 for i = 0 to String.length s2 - 1 do
5077 if String.unsafe_get s2 i = c1 then (
5078 String.unsafe_set s2 i c2;
5082 if not !r then s else s2
5086 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5088 let triml ?(test = isspace) str =
5090 let n = ref (String.length str) in
5091 while !n > 0 && test str.[!i]; do
5096 else String.sub str !i !n
5098 let trimr ?(test = isspace) str =
5099 let n = ref (String.length str) in
5100 while !n > 0 && test str.[!n-1]; do
5103 if !n = String.length str then str
5104 else String.sub str 0 !n
5106 let trim ?(test = isspace) str =
5107 trimr ~test (triml ~test str)
5109 let rec find s sub =
5110 let len = String.length s in
5111 let sublen = String.length sub in
5113 if i <= len-sublen then (
5115 if j < sublen then (
5116 if s.[i+j] = sub.[j] then loop2 (j+1)
5122 if r = -1 then loop (i+1) else r
5128 let rec replace_str s s1 s2 =
5129 let len = String.length s in
5130 let sublen = String.length s1 in
5131 let i = find s s1 in
5134 let s' = String.sub s 0 i in
5135 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5136 s' ^ s2 ^ replace_str s'' s1 s2
5139 let rec string_split sep str =
5140 let len = String.length str in
5141 let seplen = String.length sep in
5142 let i = find str sep in
5143 if i = -1 then [str]
5145 let s' = String.sub str 0 i in
5146 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5147 s' :: string_split sep s''
5150 let files_equal n1 n2 =
5151 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5152 match Sys.command cmd with
5155 | i -> failwithf "%s: failed with error code %d" cmd i
5157 let rec filter_map f = function
5161 | Some y -> y :: filter_map f xs
5162 | None -> filter_map f xs
5164 let rec find_map f = function
5165 | [] -> raise Not_found
5169 | None -> find_map f xs
5172 let rec loop i = function
5174 | x :: xs -> f i x; loop (i+1) xs
5179 let rec loop i = function
5181 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5185 let count_chars c str =
5186 let count = ref 0 in
5187 for i = 0 to String.length str - 1 do
5188 if c = String.unsafe_get str i then incr count
5194 for i = 0 to String.length str - 1 do
5195 let c = String.unsafe_get str i in
5200 let map_chars f str =
5201 List.map f (explode str)
5203 let name_of_argt = function
5204 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5205 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5206 | FileIn n | FileOut n | BufferIn n -> n
5208 let java_name_of_struct typ =
5209 try List.assoc typ java_structs
5212 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5214 let cols_of_struct typ =
5215 try List.assoc typ structs
5217 failwithf "cols_of_struct: unknown struct %s" typ
5219 let seq_of_test = function
5220 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5221 | TestOutputListOfDevices (s, _)
5222 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5223 | TestOutputTrue s | TestOutputFalse s
5224 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5225 | TestOutputStruct (s, _)
5226 | TestLastFail s -> s
5228 (* Handling for function flags. *)
5229 let protocol_limit_warning =
5230 "Because of the message protocol, there is a transfer limit
5231 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5233 let danger_will_robinson =
5234 "B<This command is dangerous. Without careful use you
5235 can easily destroy all your data>."
5237 let deprecation_notice flags =
5240 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5242 sprintf "This function is deprecated.
5243 In new code, use the C<%s> call instead.
5245 Deprecated functions will not be removed from the API, but the
5246 fact that they are deprecated indicates that there are problems
5247 with correct use of these functions." alt in
5252 (* Create list of optional groups. *)
5254 let h = Hashtbl.create 13 in
5256 fun (name, _, _, flags, _, _, _) ->
5260 let names = try Hashtbl.find h group with Not_found -> [] in
5261 Hashtbl.replace h group (name :: names)
5265 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5268 fun group -> group, List.sort compare (Hashtbl.find h group)
5270 List.sort (fun x y -> compare (fst x) (fst y)) groups
5272 (* Check function names etc. for consistency. *)
5273 let check_functions () =
5274 let contains_uppercase str =
5275 let len = String.length str in
5277 if i >= len then false
5280 if c >= 'A' && c <= 'Z' then true
5287 (* Check function names. *)
5289 fun (name, _, _, _, _, _, _) ->
5290 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5291 failwithf "function name %s does not need 'guestfs' prefix" name;
5293 failwithf "function name is empty";
5294 if name.[0] < 'a' || name.[0] > 'z' then
5295 failwithf "function name %s must start with lowercase a-z" name;
5296 if String.contains name '-' then
5297 failwithf "function name %s should not contain '-', use '_' instead."
5301 (* Check function parameter/return names. *)
5303 fun (name, style, _, _, _, _, _) ->
5304 let check_arg_ret_name n =
5305 if contains_uppercase n then
5306 failwithf "%s param/ret %s should not contain uppercase chars"
5308 if String.contains n '-' || String.contains n '_' then
5309 failwithf "%s param/ret %s should not contain '-' or '_'"
5312 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;
5313 if n = "int" || n = "char" || n = "short" || n = "long" then
5314 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5315 if n = "i" || n = "n" then
5316 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5317 if n = "argv" || n = "args" then
5318 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5320 (* List Haskell, OCaml and C keywords here.
5321 * http://www.haskell.org/haskellwiki/Keywords
5322 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5323 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5324 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5325 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5326 * Omitting _-containing words, since they're handled above.
5327 * Omitting the OCaml reserved word, "val", is ok,
5328 * and saves us from renaming several parameters.
5331 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5332 "char"; "class"; "const"; "constraint"; "continue"; "data";
5333 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5334 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5335 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5336 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5337 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5339 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5340 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5341 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5342 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5343 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5344 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5345 "volatile"; "when"; "where"; "while";
5347 if List.mem n reserved then
5348 failwithf "%s has param/ret using reserved word %s" name n;
5351 (match fst style with
5353 | RInt n | RInt64 n | RBool n
5354 | RConstString n | RConstOptString n | RString n
5355 | RStringList n | RStruct (n, _) | RStructList (n, _)
5356 | RHashtable n | RBufferOut n ->
5357 check_arg_ret_name n
5359 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5362 (* Check short descriptions. *)
5364 fun (name, _, _, _, _, shortdesc, _) ->
5365 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5366 failwithf "short description of %s should begin with lowercase." name;
5367 let c = shortdesc.[String.length shortdesc-1] in
5368 if c = '\n' || c = '.' then
5369 failwithf "short description of %s should not end with . or \\n." name
5372 (* Check long descriptions. *)
5374 fun (name, _, _, _, _, _, longdesc) ->
5375 if longdesc.[String.length longdesc-1] = '\n' then
5376 failwithf "long description of %s should not end with \\n." name
5379 (* Check proc_nrs. *)
5381 fun (name, _, proc_nr, _, _, _, _) ->
5382 if proc_nr <= 0 then
5383 failwithf "daemon function %s should have proc_nr > 0" name
5387 fun (name, _, proc_nr, _, _, _, _) ->
5388 if proc_nr <> -1 then
5389 failwithf "non-daemon function %s should have proc_nr -1" name
5390 ) non_daemon_functions;
5393 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5396 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5397 let rec loop = function
5400 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5402 | (name1,nr1) :: (name2,nr2) :: _ ->
5403 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5411 (* Ignore functions that have no tests. We generate a
5412 * warning when the user does 'make check' instead.
5414 | name, _, _, _, [], _, _ -> ()
5415 | name, _, _, _, tests, _, _ ->
5419 match seq_of_test test with
5421 failwithf "%s has a test containing an empty sequence" name
5422 | cmds -> List.map List.hd cmds
5424 let funcs = List.flatten funcs in
5426 let tested = List.mem name funcs in
5429 failwithf "function %s has tests but does not test itself" name
5432 (* 'pr' prints to the current output file. *)
5433 let chan = ref Pervasives.stdout
5438 let i = count_chars '\n' str in
5439 lines := !lines + i;
5440 output_string !chan str
5443 let copyright_years =
5444 let this_year = 1900 + (localtime (time ())).tm_year in
5445 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5447 (* Generate a header block in a number of standard styles. *)
5448 type comment_style =
5449 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5450 type license = GPLv2plus | LGPLv2plus
5452 let generate_header ?(extra_inputs = []) comment license =
5453 let inputs = "src/generator.ml" :: extra_inputs in
5454 let c = match comment with
5455 | CStyle -> pr "/* "; " *"
5456 | CPlusPlusStyle -> pr "// "; "//"
5457 | HashStyle -> pr "# "; "#"
5458 | OCamlStyle -> pr "(* "; " *"
5459 | HaskellStyle -> pr "{- "; " " in
5460 pr "libguestfs generated file\n";
5461 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5462 List.iter (pr "%s %s\n" c) inputs;
5463 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5465 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5469 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5470 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5471 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5472 pr "%s (at your option) any later version.\n" c;
5474 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5475 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5476 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5477 pr "%s GNU General Public License for more details.\n" c;
5479 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5480 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5481 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5484 pr "%s This library is free software; you can redistribute it and/or\n" c;
5485 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5486 pr "%s License as published by the Free Software Foundation; either\n" c;
5487 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5489 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5490 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5491 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5492 pr "%s Lesser General Public License for more details.\n" c;
5494 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5495 pr "%s License along with this library; if not, write to the Free Software\n" c;
5496 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5499 | CStyle -> pr " */\n"
5502 | OCamlStyle -> pr " *)\n"
5503 | HaskellStyle -> pr "-}\n"
5507 (* Start of main code generation functions below this line. *)
5509 (* Generate the pod documentation for the C API. *)
5510 let rec generate_actions_pod () =
5512 fun (shortname, style, _, flags, _, _, longdesc) ->
5513 if not (List.mem NotInDocs flags) then (
5514 let name = "guestfs_" ^ shortname in
5515 pr "=head2 %s\n\n" name;
5517 generate_prototype ~extern:false ~handle:"g" name style;
5519 pr "%s\n\n" longdesc;
5520 (match fst style with
5522 pr "This function returns 0 on success or -1 on error.\n\n"
5524 pr "On error this function returns -1.\n\n"
5526 pr "On error this function returns -1.\n\n"
5528 pr "This function returns a C truth value on success or -1 on error.\n\n"
5530 pr "This function returns a string, or NULL on error.
5531 The string is owned by the guest handle and must I<not> be freed.\n\n"
5532 | RConstOptString _ ->
5533 pr "This function returns a string which may be NULL.
5534 There is way to return an error from this function.
5535 The string is owned by the guest handle and must I<not> be freed.\n\n"
5537 pr "This function returns a string, or NULL on error.
5538 I<The caller must free the returned string after use>.\n\n"
5540 pr "This function returns a NULL-terminated array of strings
5541 (like L<environ(3)>), or NULL if there was an error.
5542 I<The caller must free the strings and the array after use>.\n\n"
5543 | RStruct (_, typ) ->
5544 pr "This function returns a C<struct guestfs_%s *>,
5545 or NULL if there was an error.
5546 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5547 | RStructList (_, typ) ->
5548 pr "This function returns a C<struct guestfs_%s_list *>
5549 (see E<lt>guestfs-structs.hE<gt>),
5550 or NULL if there was an error.
5551 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5553 pr "This function returns a NULL-terminated array of
5554 strings, or NULL if there was an error.
5555 The array of strings will always have length C<2n+1>, where
5556 C<n> keys and values alternate, followed by the trailing NULL entry.
5557 I<The caller must free the strings and the array after use>.\n\n"
5559 pr "This function returns a buffer, or NULL on error.
5560 The size of the returned buffer is written to C<*size_r>.
5561 I<The caller must free the returned buffer after use>.\n\n"
5563 if List.mem ProtocolLimitWarning flags then
5564 pr "%s\n\n" protocol_limit_warning;
5565 if List.mem DangerWillRobinson flags then
5566 pr "%s\n\n" danger_will_robinson;
5567 match deprecation_notice flags with
5569 | Some txt -> pr "%s\n\n" txt
5571 ) all_functions_sorted
5573 and generate_structs_pod () =
5574 (* Structs documentation. *)
5577 pr "=head2 guestfs_%s\n" typ;
5579 pr " struct guestfs_%s {\n" typ;
5582 | name, FChar -> pr " char %s;\n" name
5583 | name, FUInt32 -> pr " uint32_t %s;\n" name
5584 | name, FInt32 -> pr " int32_t %s;\n" name
5585 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5586 | name, FInt64 -> pr " int64_t %s;\n" name
5587 | name, FString -> pr " char *%s;\n" name
5589 pr " /* The next two fields describe a byte array. */\n";
5590 pr " uint32_t %s_len;\n" name;
5591 pr " char *%s;\n" name
5593 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5594 pr " char %s[32];\n" name
5595 | name, FOptPercent ->
5596 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5597 pr " float %s;\n" name
5601 pr " struct guestfs_%s_list {\n" typ;
5602 pr " uint32_t len; /* Number of elements in list. */\n";
5603 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5606 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5607 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5612 and generate_availability_pod () =
5613 (* Availability documentation. *)
5617 fun (group, functions) ->
5618 pr "=item B<%s>\n" group;
5620 pr "The following functions:\n";
5621 List.iter (pr "L</guestfs_%s>\n") functions;
5627 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5628 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5630 * We have to use an underscore instead of a dash because otherwise
5631 * rpcgen generates incorrect code.
5633 * This header is NOT exported to clients, but see also generate_structs_h.
5635 and generate_xdr () =
5636 generate_header CStyle LGPLv2plus;
5638 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5639 pr "typedef string str<>;\n";
5642 (* Internal structures. *)
5646 pr "struct guestfs_int_%s {\n" typ;
5648 | name, FChar -> pr " char %s;\n" name
5649 | name, FString -> pr " string %s<>;\n" name
5650 | name, FBuffer -> pr " opaque %s<>;\n" name
5651 | name, FUUID -> pr " opaque %s[32];\n" name
5652 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5653 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5654 | name, FOptPercent -> pr " float %s;\n" name
5658 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5663 fun (shortname, style, _, _, _, _, _) ->
5664 let name = "guestfs_" ^ shortname in
5666 (match snd style with
5669 pr "struct %s_args {\n" name;
5672 | Pathname n | Device n | Dev_or_Path n | String n ->
5673 pr " string %s<>;\n" n
5674 | OptString n -> pr " str *%s;\n" n
5675 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5676 | Bool n -> pr " bool %s;\n" n
5677 | Int n -> pr " int %s;\n" n
5678 | Int64 n -> pr " hyper %s;\n" n
5680 pr " opaque %s<>;\n" n
5681 | FileIn _ | FileOut _ -> ()
5685 (match fst style with
5688 pr "struct %s_ret {\n" name;
5692 pr "struct %s_ret {\n" name;
5693 pr " hyper %s;\n" n;
5696 pr "struct %s_ret {\n" name;
5699 | RConstString _ | RConstOptString _ ->
5700 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5702 pr "struct %s_ret {\n" name;
5703 pr " string %s<>;\n" n;
5706 pr "struct %s_ret {\n" name;
5707 pr " str %s<>;\n" n;
5709 | RStruct (n, typ) ->
5710 pr "struct %s_ret {\n" name;
5711 pr " guestfs_int_%s %s;\n" typ n;
5713 | RStructList (n, typ) ->
5714 pr "struct %s_ret {\n" name;
5715 pr " guestfs_int_%s_list %s;\n" typ n;
5718 pr "struct %s_ret {\n" name;
5719 pr " str %s<>;\n" n;
5722 pr "struct %s_ret {\n" name;
5723 pr " opaque %s<>;\n" n;
5728 (* Table of procedure numbers. *)
5729 pr "enum guestfs_procedure {\n";
5731 fun (shortname, _, proc_nr, _, _, _, _) ->
5732 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5734 pr " GUESTFS_PROC_NR_PROCS\n";
5738 (* Having to choose a maximum message size is annoying for several
5739 * reasons (it limits what we can do in the API), but it (a) makes
5740 * the protocol a lot simpler, and (b) provides a bound on the size
5741 * of the daemon which operates in limited memory space.
5743 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5746 (* Message header, etc. *)
5748 /* The communication protocol is now documented in the guestfs(3)
5752 const GUESTFS_PROGRAM = 0x2000F5F5;
5753 const GUESTFS_PROTOCOL_VERSION = 1;
5755 /* These constants must be larger than any possible message length. */
5756 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5757 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5759 enum guestfs_message_direction {
5760 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5761 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5764 enum guestfs_message_status {
5765 GUESTFS_STATUS_OK = 0,
5766 GUESTFS_STATUS_ERROR = 1
5769 const GUESTFS_ERROR_LEN = 256;
5771 struct guestfs_message_error {
5772 string error_message<GUESTFS_ERROR_LEN>;
5775 struct guestfs_message_header {
5776 unsigned prog; /* GUESTFS_PROGRAM */
5777 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5778 guestfs_procedure proc; /* GUESTFS_PROC_x */
5779 guestfs_message_direction direction;
5780 unsigned serial; /* message serial number */
5781 guestfs_message_status status;
5784 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5786 struct guestfs_chunk {
5787 int cancel; /* if non-zero, transfer is cancelled */
5788 /* data size is 0 bytes if the transfer has finished successfully */
5789 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5793 (* Generate the guestfs-structs.h file. *)
5794 and generate_structs_h () =
5795 generate_header CStyle LGPLv2plus;
5797 (* This is a public exported header file containing various
5798 * structures. The structures are carefully written to have
5799 * exactly the same in-memory format as the XDR structures that
5800 * we use on the wire to the daemon. The reason for creating
5801 * copies of these structures here is just so we don't have to
5802 * export the whole of guestfs_protocol.h (which includes much
5803 * unrelated and XDR-dependent stuff that we don't want to be
5804 * public, or required by clients).
5806 * To reiterate, we will pass these structures to and from the
5807 * client with a simple assignment or memcpy, so the format
5808 * must be identical to what rpcgen / the RFC defines.
5811 (* Public structures. *)
5814 pr "struct guestfs_%s {\n" typ;
5817 | name, FChar -> pr " char %s;\n" name
5818 | name, FString -> pr " char *%s;\n" name
5820 pr " uint32_t %s_len;\n" name;
5821 pr " char *%s;\n" name
5822 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5823 | name, FUInt32 -> pr " uint32_t %s;\n" name
5824 | name, FInt32 -> pr " int32_t %s;\n" name
5825 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5826 | name, FInt64 -> pr " int64_t %s;\n" name
5827 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5831 pr "struct guestfs_%s_list {\n" typ;
5832 pr " uint32_t len;\n";
5833 pr " struct guestfs_%s *val;\n" typ;
5836 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5837 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5841 (* Generate the guestfs-actions.h file. *)
5842 and generate_actions_h () =
5843 generate_header CStyle LGPLv2plus;
5845 fun (shortname, style, _, _, _, _, _) ->
5846 let name = "guestfs_" ^ shortname in
5847 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5851 (* Generate the guestfs-internal-actions.h file. *)
5852 and generate_internal_actions_h () =
5853 generate_header CStyle LGPLv2plus;
5855 fun (shortname, style, _, _, _, _, _) ->
5856 let name = "guestfs__" ^ shortname in
5857 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5859 ) non_daemon_functions
5861 (* Generate the client-side dispatch stubs. *)
5862 and generate_client_actions () =
5863 generate_header CStyle LGPLv2plus;
5870 #include <inttypes.h>
5872 #include \"guestfs.h\"
5873 #include \"guestfs-internal.h\"
5874 #include \"guestfs-internal-actions.h\"
5875 #include \"guestfs_protocol.h\"
5877 #define error guestfs_error
5878 //#define perrorf guestfs_perrorf
5879 #define safe_malloc guestfs_safe_malloc
5880 #define safe_realloc guestfs_safe_realloc
5881 //#define safe_strdup guestfs_safe_strdup
5882 #define safe_memdup guestfs_safe_memdup
5884 /* Check the return message from a call for validity. */
5886 check_reply_header (guestfs_h *g,
5887 const struct guestfs_message_header *hdr,
5888 unsigned int proc_nr, unsigned int serial)
5890 if (hdr->prog != GUESTFS_PROGRAM) {
5891 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5894 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5895 error (g, \"wrong protocol version (%%d/%%d)\",
5896 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5899 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5900 error (g, \"unexpected message direction (%%d/%%d)\",
5901 hdr->direction, GUESTFS_DIRECTION_REPLY);
5904 if (hdr->proc != proc_nr) {
5905 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5908 if (hdr->serial != serial) {
5909 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5916 /* Check we are in the right state to run a high-level action. */
5918 check_state (guestfs_h *g, const char *caller)
5920 if (!guestfs__is_ready (g)) {
5921 if (guestfs__is_config (g) || guestfs__is_launching (g))
5922 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5925 error (g, \"%%s called from the wrong state, %%d != READY\",
5926 caller, guestfs__get_state (g));
5934 let error_code_of = function
5935 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5936 | RConstString _ | RConstOptString _
5937 | RString _ | RStringList _
5938 | RStruct _ | RStructList _
5939 | RHashtable _ | RBufferOut _ -> "NULL"
5942 (* Generate code to check String-like parameters are not passed in
5943 * as NULL (returning an error if they are).
5945 let check_null_strings shortname style =
5946 let pr_newline = ref false in
5949 (* parameters which should not be NULL *)
5959 pr " if (%s == NULL) {\n" n;
5960 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
5961 pr " \"%s\", \"%s\");\n" shortname n;
5962 pr " return %s;\n" (error_code_of (fst style));
5969 (* not applicable *)
5975 if !pr_newline then pr "\n";
5978 (* Generate code to generate guestfish call traces. *)
5979 let trace_call shortname style =
5980 pr " if (guestfs__get_trace (g)) {\n";
5983 List.exists (function
5984 | StringList _ | DeviceList _ -> true
5985 | _ -> false) (snd style) in
5991 pr " printf (\"%s\");\n" shortname;
5994 | String n (* strings *)
6001 (* guestfish doesn't support string escaping, so neither do we *)
6002 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
6003 | OptString n -> (* string option *)
6004 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
6005 pr " else printf (\" null\");\n"
6007 | DeviceList n -> (* string list *)
6008 pr " putchar (' ');\n";
6009 pr " putchar ('\"');\n";
6010 pr " for (i = 0; %s[i]; ++i) {\n" n;
6011 pr " if (i > 0) putchar (' ');\n";
6012 pr " fputs (%s[i], stdout);\n" n;
6014 pr " putchar ('\"');\n";
6015 | Bool n -> (* boolean *)
6016 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
6017 | Int n -> (* int *)
6018 pr " printf (\" %%d\", %s);\n" n
6020 pr " printf (\" %%\" PRIi64, %s);\n" n
6022 pr " putchar ('\\n');\n";
6027 (* For non-daemon functions, generate a wrapper around each function. *)
6029 fun (shortname, style, _, _, _, _, _) ->
6030 let name = "guestfs_" ^ shortname in
6032 generate_prototype ~extern:false ~semicolon:false ~newline:true
6033 ~handle:"g" name style;
6035 check_null_strings shortname style;
6036 trace_call shortname style;
6037 pr " return guestfs__%s " shortname;
6038 generate_c_call_args ~handle:"g" style;
6042 ) non_daemon_functions;
6044 (* Client-side stubs for each function. *)
6046 fun (shortname, style, _, _, _, _, _) ->
6047 let name = "guestfs_" ^ shortname in
6048 let error_code = error_code_of (fst style) in
6050 (* Generate the action stub. *)
6051 generate_prototype ~extern:false ~semicolon:false ~newline:true
6052 ~handle:"g" name style;
6056 (match snd style with
6058 | _ -> pr " struct %s_args args;\n" name
6061 pr " guestfs_message_header hdr;\n";
6062 pr " guestfs_message_error err;\n";
6064 match fst style with
6066 | RConstString _ | RConstOptString _ ->
6067 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6069 | RBool _ | RString _ | RStringList _
6070 | RStruct _ | RStructList _
6071 | RHashtable _ | RBufferOut _ ->
6072 pr " struct %s_ret ret;\n" name;
6075 pr " int serial;\n";
6078 check_null_strings shortname style;
6079 trace_call shortname style;
6080 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
6081 shortname error_code;
6082 pr " guestfs___set_busy (g);\n";
6085 (* Send the main header and arguments. *)
6086 (match snd style with
6088 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6089 (String.uppercase shortname)
6093 | Pathname n | Device n | Dev_or_Path n | String n ->
6094 pr " args.%s = (char *) %s;\n" n n
6096 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6097 | StringList n | DeviceList n ->
6098 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6099 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6101 pr " args.%s = %s;\n" n n
6103 pr " args.%s = %s;\n" n n
6105 pr " args.%s = %s;\n" n n
6106 | FileIn _ | FileOut _ -> ()
6108 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6109 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6110 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6112 pr " guestfs___end_busy (g);\n";
6113 pr " return %s;\n" error_code;
6115 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6116 pr " args.%s.%s_len = %s_size;\n" n n n
6118 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6119 (String.uppercase shortname);
6120 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6123 pr " if (serial == -1) {\n";
6124 pr " guestfs___end_busy (g);\n";
6125 pr " return %s;\n" error_code;
6129 (* Send any additional files (FileIn) requested. *)
6130 let need_read_reply_label = ref false in
6134 pr " r = guestfs___send_file (g, %s);\n" n;
6135 pr " if (r == -1) {\n";
6136 pr " guestfs___end_busy (g);\n";
6137 pr " return %s;\n" error_code;
6139 pr " if (r == -2) /* daemon cancelled */\n";
6140 pr " goto read_reply;\n";
6141 need_read_reply_label := true;
6146 (* Wait for the reply from the remote end. *)
6147 if !need_read_reply_label then pr " read_reply:\n";
6148 pr " memset (&hdr, 0, sizeof hdr);\n";
6149 pr " memset (&err, 0, sizeof err);\n";
6150 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6152 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6156 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6159 pr " if (r == -1) {\n";
6160 pr " guestfs___end_busy (g);\n";
6161 pr " return %s;\n" error_code;
6165 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6166 (String.uppercase shortname);
6167 pr " guestfs___end_busy (g);\n";
6168 pr " return %s;\n" error_code;
6172 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6173 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6174 pr " free (err.error_message);\n";
6175 pr " guestfs___end_busy (g);\n";
6176 pr " return %s;\n" error_code;
6180 (* Expecting to receive further files (FileOut)? *)
6184 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6185 pr " guestfs___end_busy (g);\n";
6186 pr " return %s;\n" error_code;
6192 pr " guestfs___end_busy (g);\n";
6194 (match fst style with
6195 | RErr -> pr " return 0;\n"
6196 | RInt n | RInt64 n | RBool n ->
6197 pr " return ret.%s;\n" n
6198 | RConstString _ | RConstOptString _ ->
6199 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6201 pr " return ret.%s; /* caller will free */\n" n
6202 | RStringList n | RHashtable n ->
6203 pr " /* caller will free this, but we need to add a NULL entry */\n";
6204 pr " ret.%s.%s_val =\n" n n;
6205 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6206 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6208 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6209 pr " return ret.%s.%s_val;\n" n n
6211 pr " /* caller will free this */\n";
6212 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6213 | RStructList (n, _) ->
6214 pr " /* caller will free this */\n";
6215 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6217 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6218 pr " * _val might be NULL here. To make the API saner for\n";
6219 pr " * callers, we turn this case into a unique pointer (using\n";
6220 pr " * malloc(1)).\n";
6222 pr " if (ret.%s.%s_len > 0) {\n" n n;
6223 pr " *size_r = ret.%s.%s_len;\n" n n;
6224 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6226 pr " free (ret.%s.%s_val);\n" n n;
6227 pr " char *p = safe_malloc (g, 1);\n";
6228 pr " *size_r = ret.%s.%s_len;\n" n n;
6236 (* Functions to free structures. *)
6237 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6238 pr " * structure format is identical to the XDR format. See note in\n";
6239 pr " * generator.ml.\n";
6246 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6248 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6254 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6256 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6263 (* Generate daemon/actions.h. *)
6264 and generate_daemon_actions_h () =
6265 generate_header CStyle GPLv2plus;
6267 pr "#include \"../src/guestfs_protocol.h\"\n";
6271 fun (name, style, _, _, _, _, _) ->
6273 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6277 (* Generate the linker script which controls the visibility of
6278 * symbols in the public ABI and ensures no other symbols get
6279 * exported accidentally.
6281 and generate_linker_script () =
6282 generate_header HashStyle GPLv2plus;
6287 "guestfs_get_error_handler";
6288 "guestfs_get_out_of_memory_handler";
6289 "guestfs_last_error";
6290 "guestfs_set_error_handler";
6291 "guestfs_set_launch_done_callback";
6292 "guestfs_set_log_message_callback";
6293 "guestfs_set_out_of_memory_handler";
6294 "guestfs_set_subprocess_quit_callback";
6296 (* Unofficial parts of the API: the bindings code use these
6297 * functions, so it is useful to export them.
6299 "guestfs_safe_calloc";
6300 "guestfs_safe_malloc";
6303 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6307 List.map (fun (typ, _) ->
6308 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6311 let globals = List.sort compare (globals @ functions @ structs) in
6315 List.iter (pr " %s;\n") globals;
6322 (* Generate the server-side stubs. *)
6323 and generate_daemon_actions () =
6324 generate_header CStyle GPLv2plus;
6326 pr "#include <config.h>\n";
6328 pr "#include <stdio.h>\n";
6329 pr "#include <stdlib.h>\n";
6330 pr "#include <string.h>\n";
6331 pr "#include <inttypes.h>\n";
6332 pr "#include <rpc/types.h>\n";
6333 pr "#include <rpc/xdr.h>\n";
6335 pr "#include \"daemon.h\"\n";
6336 pr "#include \"c-ctype.h\"\n";
6337 pr "#include \"../src/guestfs_protocol.h\"\n";
6338 pr "#include \"actions.h\"\n";
6342 fun (name, style, _, _, _, _, _) ->
6343 (* Generate server-side stubs. *)
6344 pr "static void %s_stub (XDR *xdr_in)\n" name;
6347 match fst style with
6348 | RErr | RInt _ -> pr " int r;\n"; "-1"
6349 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6350 | RBool _ -> pr " int r;\n"; "-1"
6351 | RConstString _ | RConstOptString _ ->
6352 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6353 | RString _ -> pr " char *r;\n"; "NULL"
6354 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6355 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6356 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6358 pr " size_t size = 1;\n";
6362 (match snd style with
6365 pr " struct guestfs_%s_args args;\n" name;
6368 | Device n | Dev_or_Path n
6371 | OptString n -> pr " char *%s;\n" n
6372 | StringList n | DeviceList n -> pr " char **%s;\n" n
6373 | Bool n -> pr " int %s;\n" n
6374 | Int n -> pr " int %s;\n" n
6375 | Int64 n -> pr " int64_t %s;\n" n
6376 | FileIn _ | FileOut _ -> ()
6378 pr " const char *%s;\n" n;
6379 pr " size_t %s_size;\n" n
6385 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6387 (match snd style with
6390 pr " memset (&args, 0, sizeof args);\n";
6392 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6394 pr " if (cancel_receive () != -2)\n";
6395 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6399 pr " char *%s = args.%s;\n" n n
6401 let pr_list_handling_code n =
6402 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6403 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6404 pr " if (%s == NULL) {\n" n;
6406 pr " if (cancel_receive () != -2)\n";
6407 pr " reply_with_perror (\"realloc\");\n";
6410 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6411 pr " args.%s.%s_val = %s;\n" n n n;
6417 pr " ABS_PATH (%s, %s, goto done);\n"
6418 n (if is_filein then "cancel_receive ()" else "0");
6421 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6422 n (if is_filein then "cancel_receive ()" else "0");
6425 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6426 n (if is_filein then "cancel_receive ()" else "0");
6427 | String n -> pr_args n
6428 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6430 pr_list_handling_code n;
6432 pr_list_handling_code n;
6433 pr " /* Ensure that each is a device,\n";
6434 pr " * and perform device name translation. */\n";
6435 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6436 pr " RESOLVE_DEVICE (physvols[pvi], %s, goto done);\n"
6437 (if is_filein then "cancel_receive ()" else "0");
6439 | Bool n -> pr " %s = args.%s;\n" n n
6440 | Int n -> pr " %s = args.%s;\n" n n
6441 | Int64 n -> pr " %s = args.%s;\n" n n
6442 | FileIn _ | FileOut _ -> ()
6444 pr " %s = args.%s.%s_val;\n" n n n;
6445 pr " %s_size = args.%s.%s_len;\n" n n n
6450 (* this is used at least for do_equal *)
6451 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6452 (* Emit NEED_ROOT just once, even when there are two or
6453 more Pathname args *)
6454 pr " NEED_ROOT (%s, goto done);\n"
6455 (if is_filein then "cancel_receive ()" else "0");
6458 (* Don't want to call the impl with any FileIn or FileOut
6459 * parameters, since these go "outside" the RPC protocol.
6462 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6464 pr " r = do_%s " name;
6465 generate_c_call_args (fst style, args');
6468 (match fst style with
6469 | RErr | RInt _ | RInt64 _ | RBool _
6470 | RConstString _ | RConstOptString _
6471 | RString _ | RStringList _ | RHashtable _
6472 | RStruct (_, _) | RStructList (_, _) ->
6473 pr " if (r == %s)\n" error_code;
6474 pr " /* do_%s has already called reply_with_error */\n" name;
6478 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6479 pr " * an ordinary zero-length buffer), so be careful ...\n";
6481 pr " if (size == 1 && r == %s)\n" error_code;
6482 pr " /* do_%s has already called reply_with_error */\n" name;
6487 (* If there are any FileOut parameters, then the impl must
6488 * send its own reply.
6491 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6493 pr " /* do_%s has already sent a reply */\n" name
6495 match fst style with
6496 | RErr -> pr " reply (NULL, NULL);\n"
6497 | RInt n | RInt64 n | RBool n ->
6498 pr " struct guestfs_%s_ret ret;\n" name;
6499 pr " ret.%s = r;\n" n;
6500 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6502 | RConstString _ | RConstOptString _ ->
6503 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6505 pr " struct guestfs_%s_ret ret;\n" name;
6506 pr " ret.%s = r;\n" n;
6507 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6510 | RStringList n | RHashtable n ->
6511 pr " struct guestfs_%s_ret ret;\n" name;
6512 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6513 pr " ret.%s.%s_val = r;\n" n n;
6514 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6516 pr " free_strings (r);\n"
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"
6522 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6524 | RStructList (n, _) ->
6525 pr " struct guestfs_%s_ret ret;\n" name;
6526 pr " ret.%s = *r;\n" n;
6527 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6529 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6532 pr " struct guestfs_%s_ret ret;\n" name;
6533 pr " ret.%s.%s_val = r;\n" n n;
6534 pr " ret.%s.%s_len = size;\n" n n;
6535 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6540 (* Free the args. *)
6542 (match snd style with
6545 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6552 (* Dispatch function. *)
6553 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6555 pr " switch (proc_nr) {\n";
6558 fun (name, style, _, _, _, _, _) ->
6559 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6560 pr " %s_stub (xdr_in);\n" name;
6565 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";
6570 (* LVM columns and tokenization functions. *)
6571 (* XXX This generates crap code. We should rethink how we
6577 pr "static const char *lvm_%s_cols = \"%s\";\n"
6578 typ (String.concat "," (List.map fst cols));
6581 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6583 pr " char *tok, *p, *next;\n";
6587 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6590 pr " if (!str) {\n";
6591 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6594 pr " if (!*str || c_isspace (*str)) {\n";
6595 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6600 fun (name, coltype) ->
6601 pr " if (!tok) {\n";
6602 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6605 pr " p = strchrnul (tok, ',');\n";
6606 pr " if (*p) next = p+1; else next = NULL;\n";
6607 pr " *p = '\\0';\n";
6610 pr " r->%s = strdup (tok);\n" name;
6611 pr " if (r->%s == NULL) {\n" name;
6612 pr " perror (\"strdup\");\n";
6616 pr " for (i = j = 0; i < 32; ++j) {\n";
6617 pr " if (tok[j] == '\\0') {\n";
6618 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6620 pr " } else if (tok[j] != '-')\n";
6621 pr " r->%s[i++] = tok[j];\n" name;
6624 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6625 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6629 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6630 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6634 pr " if (tok[0] == '\\0')\n";
6635 pr " r->%s = -1;\n" name;
6636 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6637 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6640 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6641 assert false (* can never be an LVM column *)
6643 pr " tok = next;\n";
6646 pr " if (tok != NULL) {\n";
6647 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6654 pr "guestfs_int_lvm_%s_list *\n" typ;
6655 pr "parse_command_line_%ss (void)\n" typ;
6657 pr " char *out, *err;\n";
6658 pr " char *p, *pend;\n";
6660 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6661 pr " void *newp;\n";
6663 pr " ret = malloc (sizeof *ret);\n";
6664 pr " if (!ret) {\n";
6665 pr " reply_with_perror (\"malloc\");\n";
6666 pr " return NULL;\n";
6669 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6670 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6672 pr " r = command (&out, &err,\n";
6673 pr " \"lvm\", \"%ss\",\n" typ;
6674 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6675 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6676 pr " if (r == -1) {\n";
6677 pr " reply_with_error (\"%%s\", err);\n";
6678 pr " free (out);\n";
6679 pr " free (err);\n";
6680 pr " free (ret);\n";
6681 pr " return NULL;\n";
6684 pr " free (err);\n";
6686 pr " /* Tokenize each line of the output. */\n";
6689 pr " while (p) {\n";
6690 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6691 pr " if (pend) {\n";
6692 pr " *pend = '\\0';\n";
6696 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6699 pr " if (!*p) { /* Empty line? Skip it. */\n";
6704 pr " /* Allocate some space to store this next entry. */\n";
6705 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6706 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6707 pr " if (newp == NULL) {\n";
6708 pr " reply_with_perror (\"realloc\");\n";
6709 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6710 pr " free (ret);\n";
6711 pr " free (out);\n";
6712 pr " return NULL;\n";
6714 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6716 pr " /* Tokenize the next entry. */\n";
6717 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6718 pr " if (r == -1) {\n";
6719 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6720 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6721 pr " free (ret);\n";
6722 pr " free (out);\n";
6723 pr " return NULL;\n";
6730 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6732 pr " free (out);\n";
6733 pr " return ret;\n";
6736 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6738 (* Generate a list of function names, for debugging in the daemon.. *)
6739 and generate_daemon_names () =
6740 generate_header CStyle GPLv2plus;
6742 pr "#include <config.h>\n";
6744 pr "#include \"daemon.h\"\n";
6747 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6748 pr "const char *function_names[] = {\n";
6750 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6754 (* Generate the optional groups for the daemon to implement
6755 * guestfs_available.
6757 and generate_daemon_optgroups_c () =
6758 generate_header CStyle GPLv2plus;
6760 pr "#include <config.h>\n";
6762 pr "#include \"daemon.h\"\n";
6763 pr "#include \"optgroups.h\"\n";
6766 pr "struct optgroup optgroups[] = {\n";
6769 pr " { \"%s\", optgroup_%s_available },\n" group group
6771 pr " { NULL, NULL }\n";
6774 and generate_daemon_optgroups_h () =
6775 generate_header CStyle GPLv2plus;
6779 pr "extern int optgroup_%s_available (void);\n" group
6782 (* Generate the tests. *)
6783 and generate_tests () =
6784 generate_header CStyle GPLv2plus;
6791 #include <sys/types.h>
6794 #include \"guestfs.h\"
6795 #include \"guestfs-internal.h\"
6797 static guestfs_h *g;
6798 static int suppress_error = 0;
6800 static void print_error (guestfs_h *g, void *data, const char *msg)
6802 if (!suppress_error)
6803 fprintf (stderr, \"%%s\\n\", msg);
6806 /* FIXME: nearly identical code appears in fish.c */
6807 static void print_strings (char *const *argv)
6811 for (argc = 0; argv[argc] != NULL; ++argc)
6812 printf (\"\\t%%s\\n\", argv[argc]);
6816 static void print_table (char const *const *argv)
6820 for (i = 0; argv[i] != NULL; i += 2)
6821 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6827 (* Generate a list of commands which are not tested anywhere. *)
6828 pr "static void no_test_warnings (void)\n";
6831 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6833 fun (_, _, _, _, tests, _, _) ->
6834 let tests = filter_map (
6836 | (_, (Always|If _|Unless _), test) -> Some test
6837 | (_, Disabled, _) -> None
6839 let seq = List.concat (List.map seq_of_test tests) in
6840 let cmds_tested = List.map List.hd seq in
6841 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6845 fun (name, _, _, _, _, _, _) ->
6846 if not (Hashtbl.mem hash name) then
6847 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6853 (* Generate the actual tests. Note that we generate the tests
6854 * in reverse order, deliberately, so that (in general) the
6855 * newest tests run first. This makes it quicker and easier to
6860 fun (name, _, _, flags, tests, _, _) ->
6861 mapi (generate_one_test name flags) tests
6862 ) (List.rev all_functions) in
6863 let test_names = List.concat test_names in
6864 let nr_tests = List.length test_names in
6867 int main (int argc, char *argv[])
6870 unsigned long int n_failed = 0;
6871 const char *filename;
6873 int nr_tests, test_num = 0;
6875 setbuf (stdout, NULL);
6877 no_test_warnings ();
6879 g = guestfs_create ();
6881 printf (\"guestfs_create FAILED\\n\");
6882 exit (EXIT_FAILURE);
6885 guestfs_set_error_handler (g, print_error, NULL);
6887 guestfs_set_path (g, \"../appliance\");
6889 filename = \"test1.img\";
6890 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6893 exit (EXIT_FAILURE);
6895 if (lseek (fd, %d, SEEK_SET) == -1) {
6899 exit (EXIT_FAILURE);
6901 if (write (fd, &c, 1) == -1) {
6905 exit (EXIT_FAILURE);
6907 if (close (fd) == -1) {
6910 exit (EXIT_FAILURE);
6912 if (guestfs_add_drive (g, filename) == -1) {
6913 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6914 exit (EXIT_FAILURE);
6917 filename = \"test2.img\";
6918 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6921 exit (EXIT_FAILURE);
6923 if (lseek (fd, %d, SEEK_SET) == -1) {
6927 exit (EXIT_FAILURE);
6929 if (write (fd, &c, 1) == -1) {
6933 exit (EXIT_FAILURE);
6935 if (close (fd) == -1) {
6938 exit (EXIT_FAILURE);
6940 if (guestfs_add_drive (g, filename) == -1) {
6941 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6942 exit (EXIT_FAILURE);
6945 filename = \"test3.img\";
6946 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6949 exit (EXIT_FAILURE);
6951 if (lseek (fd, %d, SEEK_SET) == -1) {
6955 exit (EXIT_FAILURE);
6957 if (write (fd, &c, 1) == -1) {
6961 exit (EXIT_FAILURE);
6963 if (close (fd) == -1) {
6966 exit (EXIT_FAILURE);
6968 if (guestfs_add_drive (g, filename) == -1) {
6969 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6970 exit (EXIT_FAILURE);
6973 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6974 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6975 exit (EXIT_FAILURE);
6978 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6981 if (guestfs_launch (g) == -1) {
6982 printf (\"guestfs_launch FAILED\\n\");
6983 exit (EXIT_FAILURE);
6986 /* Cancel previous alarm. */
6991 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6995 pr " test_num++;\n";
6996 pr " if (guestfs_get_verbose (g))\n";
6997 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
6998 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6999 pr " if (%s () == -1) {\n" test_name;
7000 pr " printf (\"%s FAILED\\n\");\n" test_name;
7001 pr " n_failed++;\n";
7006 pr " guestfs_close (g);\n";
7007 pr " unlink (\"test1.img\");\n";
7008 pr " unlink (\"test2.img\");\n";
7009 pr " unlink (\"test3.img\");\n";
7012 pr " if (n_failed > 0) {\n";
7013 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
7014 pr " exit (EXIT_FAILURE);\n";
7018 pr " exit (EXIT_SUCCESS);\n";
7021 and generate_one_test name flags i (init, prereq, test) =
7022 let test_name = sprintf "test_%s_%d" name i in
7025 static int %s_skip (void)
7029 str = getenv (\"TEST_ONLY\");
7031 return strstr (str, \"%s\") == NULL;
7032 str = getenv (\"SKIP_%s\");
7033 if (str && STREQ (str, \"1\")) return 1;
7034 str = getenv (\"SKIP_TEST_%s\");
7035 if (str && STREQ (str, \"1\")) return 1;
7039 " test_name name (String.uppercase test_name) (String.uppercase name);
7042 | Disabled | Always -> ()
7043 | If code | Unless code ->
7044 pr "static int %s_prereq (void)\n" test_name;
7052 static int %s (void)
7055 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
7059 " test_name test_name test_name;
7061 (* Optional functions should only be tested if the relevant
7062 * support is available in the daemon.
7068 pr " const char *groups[] = { \"%s\", NULL };\n" group;
7070 pr " suppress_error = 1;\n";
7071 pr " r = guestfs_available (g, (char **) groups);\n";
7072 pr " suppress_error = 0;\n";
7073 pr " if (r == -1) {\n";
7074 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
7083 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7085 pr " if (! %s_prereq ()) {\n" test_name;
7086 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7090 generate_one_test_body name i test_name init test;
7092 pr " if (%s_prereq ()) {\n" test_name;
7093 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7097 generate_one_test_body name i test_name init test;
7099 generate_one_test_body name i test_name init test
7107 and generate_one_test_body name i test_name init test =
7109 | InitNone (* XXX at some point, InitNone and InitEmpty became
7110 * folded together as the same thing. Really we should
7111 * make InitNone do nothing at all, but the tests may
7112 * need to be checked to make sure this is OK.
7115 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7116 List.iter (generate_test_command_call test_name)
7117 [["blockdev_setrw"; "/dev/sda"];
7121 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7122 List.iter (generate_test_command_call test_name)
7123 [["blockdev_setrw"; "/dev/sda"];
7126 ["part_disk"; "/dev/sda"; "mbr"]]
7128 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7129 List.iter (generate_test_command_call test_name)
7130 [["blockdev_setrw"; "/dev/sda"];
7133 ["part_disk"; "/dev/sda"; "mbr"];
7134 ["mkfs"; "ext2"; "/dev/sda1"];
7135 ["mount_options"; ""; "/dev/sda1"; "/"]]
7136 | InitBasicFSonLVM ->
7137 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7139 List.iter (generate_test_command_call test_name)
7140 [["blockdev_setrw"; "/dev/sda"];
7143 ["part_disk"; "/dev/sda"; "mbr"];
7144 ["pvcreate"; "/dev/sda1"];
7145 ["vgcreate"; "VG"; "/dev/sda1"];
7146 ["lvcreate"; "LV"; "VG"; "8"];
7147 ["mkfs"; "ext2"; "/dev/VG/LV"];
7148 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7150 pr " /* InitISOFS for %s */\n" test_name;
7151 List.iter (generate_test_command_call test_name)
7152 [["blockdev_setrw"; "/dev/sda"];
7155 ["mount_ro"; "/dev/sdd"; "/"]]
7158 let get_seq_last = function
7160 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7163 let seq = List.rev seq in
7164 List.rev (List.tl seq), List.hd seq
7169 pr " /* TestRun for %s (%d) */\n" name i;
7170 List.iter (generate_test_command_call test_name) seq
7171 | TestOutput (seq, expected) ->
7172 pr " /* TestOutput for %s (%d) */\n" name i;
7173 pr " const char *expected = \"%s\";\n" (c_quote expected);
7174 let seq, last = get_seq_last seq in
7176 pr " if (STRNEQ (r, expected)) {\n";
7177 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7181 List.iter (generate_test_command_call test_name) seq;
7182 generate_test_command_call ~test test_name last
7183 | TestOutputList (seq, expected) ->
7184 pr " /* TestOutputList for %s (%d) */\n" name i;
7185 let seq, last = get_seq_last seq in
7189 pr " if (!r[%d]) {\n" i;
7190 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7191 pr " print_strings (r);\n";
7195 pr " const char *expected = \"%s\";\n" (c_quote str);
7196 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7197 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7202 pr " if (r[%d] != NULL) {\n" (List.length expected);
7203 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7205 pr " print_strings (r);\n";
7209 List.iter (generate_test_command_call test_name) seq;
7210 generate_test_command_call ~test test_name last
7211 | TestOutputListOfDevices (seq, expected) ->
7212 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7213 let seq, last = get_seq_last seq in
7217 pr " if (!r[%d]) {\n" i;
7218 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7219 pr " print_strings (r);\n";
7223 pr " const char *expected = \"%s\";\n" (c_quote str);
7224 pr " r[%d][5] = 's';\n" i;
7225 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7226 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7231 pr " if (r[%d] != NULL) {\n" (List.length expected);
7232 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7234 pr " print_strings (r);\n";
7238 List.iter (generate_test_command_call test_name) seq;
7239 generate_test_command_call ~test test_name last
7240 | TestOutputInt (seq, expected) ->
7241 pr " /* TestOutputInt for %s (%d) */\n" name i;
7242 let seq, last = get_seq_last seq in
7244 pr " if (r != %d) {\n" expected;
7245 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7251 List.iter (generate_test_command_call test_name) seq;
7252 generate_test_command_call ~test test_name last
7253 | TestOutputIntOp (seq, op, expected) ->
7254 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7255 let seq, last = get_seq_last seq in
7257 pr " if (! (r %s %d)) {\n" op expected;
7258 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7259 test_name op expected;
7264 List.iter (generate_test_command_call test_name) seq;
7265 generate_test_command_call ~test test_name last
7266 | TestOutputTrue seq ->
7267 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7268 let seq, last = get_seq_last seq in
7271 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7276 List.iter (generate_test_command_call test_name) seq;
7277 generate_test_command_call ~test test_name last
7278 | TestOutputFalse seq ->
7279 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7280 let seq, last = get_seq_last seq in
7283 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7288 List.iter (generate_test_command_call test_name) seq;
7289 generate_test_command_call ~test test_name last
7290 | TestOutputLength (seq, expected) ->
7291 pr " /* TestOutputLength for %s (%d) */\n" name i;
7292 let seq, last = get_seq_last seq in
7295 pr " for (j = 0; j < %d; ++j)\n" expected;
7296 pr " if (r[j] == NULL) {\n";
7297 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7299 pr " print_strings (r);\n";
7302 pr " if (r[j] != NULL) {\n";
7303 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7305 pr " print_strings (r);\n";
7309 List.iter (generate_test_command_call test_name) seq;
7310 generate_test_command_call ~test test_name last
7311 | TestOutputBuffer (seq, expected) ->
7312 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7313 pr " const char *expected = \"%s\";\n" (c_quote expected);
7314 let seq, last = get_seq_last seq in
7315 let len = String.length expected in
7317 pr " if (size != %d) {\n" len;
7318 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7321 pr " if (STRNEQLEN (r, expected, size)) {\n";
7322 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7326 List.iter (generate_test_command_call test_name) seq;
7327 generate_test_command_call ~test test_name last
7328 | TestOutputStruct (seq, checks) ->
7329 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7330 let seq, last = get_seq_last seq in
7334 | CompareWithInt (field, expected) ->
7335 pr " if (r->%s != %d) {\n" field expected;
7336 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7337 test_name field expected;
7338 pr " (int) r->%s);\n" field;
7341 | CompareWithIntOp (field, op, expected) ->
7342 pr " if (!(r->%s %s %d)) {\n" field op expected;
7343 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7344 test_name field op expected;
7345 pr " (int) r->%s);\n" field;
7348 | CompareWithString (field, expected) ->
7349 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7350 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7351 test_name field expected;
7352 pr " r->%s);\n" field;
7355 | CompareFieldsIntEq (field1, field2) ->
7356 pr " if (r->%s != r->%s) {\n" field1 field2;
7357 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7358 test_name field1 field2;
7359 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7362 | CompareFieldsStrEq (field1, field2) ->
7363 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7364 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7365 test_name field1 field2;
7366 pr " r->%s, r->%s);\n" field1 field2;
7371 List.iter (generate_test_command_call test_name) seq;
7372 generate_test_command_call ~test test_name last
7373 | TestLastFail seq ->
7374 pr " /* TestLastFail for %s (%d) */\n" name i;
7375 let seq, last = get_seq_last seq in
7376 List.iter (generate_test_command_call test_name) seq;
7377 generate_test_command_call test_name ~expect_error:true last
7379 (* Generate the code to run a command, leaving the result in 'r'.
7380 * If you expect to get an error then you should set expect_error:true.
7382 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7384 | [] -> assert false
7386 (* Look up the command to find out what args/ret it has. *)
7389 let _, style, _, _, _, _, _ =
7390 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7393 failwithf "%s: in test, command %s was not found" test_name name in
7395 if List.length (snd style) <> List.length args then
7396 failwithf "%s: in test, wrong number of args given to %s"
7403 | OptString n, "NULL" -> ()
7406 | Dev_or_Path n, arg
7408 | OptString n, arg ->
7409 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7410 | BufferIn n, arg ->
7411 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7412 pr " size_t %s_size = %d;\n" n (String.length arg)
7416 | FileIn _, _ | FileOut _, _ -> ()
7417 | StringList n, "" | DeviceList n, "" ->
7418 pr " const char *const %s[1] = { NULL };\n" n
7419 | StringList n, arg | DeviceList n, arg ->
7420 let strs = string_split " " arg in
7423 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7425 pr " const char *const %s[] = {\n" n;
7427 fun i _ -> pr " %s_%d,\n" n i
7431 ) (List.combine (snd style) args);
7434 match fst style with
7435 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7436 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7437 | RConstString _ | RConstOptString _ ->
7438 pr " const char *r;\n"; "NULL"
7439 | RString _ -> pr " char *r;\n"; "NULL"
7440 | RStringList _ | RHashtable _ ->
7444 | RStruct (_, typ) ->
7445 pr " struct guestfs_%s *r;\n" typ; "NULL"
7446 | RStructList (_, typ) ->
7447 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7450 pr " size_t size;\n";
7453 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7454 pr " r = guestfs_%s (g" name;
7456 (* Generate the parameters. *)
7459 | OptString _, "NULL" -> pr ", NULL"
7461 | Device n, _ | Dev_or_Path n, _
7466 pr ", %s, %s_size" n n
7467 | FileIn _, arg | FileOut _, arg ->
7468 pr ", \"%s\"" (c_quote arg)
7469 | StringList n, _ | DeviceList n, _ ->
7470 pr ", (char **) %s" n
7473 try int_of_string arg
7474 with Failure "int_of_string" ->
7475 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7479 try Int64.of_string arg
7480 with Failure "int_of_string" ->
7481 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7484 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7485 ) (List.combine (snd style) args);
7487 (match fst style with
7488 | RBufferOut _ -> pr ", &size"
7494 if not expect_error then
7495 pr " if (r == %s)\n" error_code
7497 pr " if (r != %s)\n" error_code;
7500 (* Insert the test code. *)
7506 (match fst style with
7507 | RErr | RInt _ | RInt64 _ | RBool _
7508 | RConstString _ | RConstOptString _ -> ()
7509 | RString _ | RBufferOut _ -> pr " free (r);\n"
7510 | RStringList _ | RHashtable _ ->
7511 pr " for (i = 0; r[i] != NULL; ++i)\n";
7512 pr " free (r[i]);\n";
7514 | RStruct (_, typ) ->
7515 pr " guestfs_free_%s (r);\n" typ
7516 | RStructList (_, typ) ->
7517 pr " guestfs_free_%s_list (r);\n" typ
7523 let str = replace_str str "\r" "\\r" in
7524 let str = replace_str str "\n" "\\n" in
7525 let str = replace_str str "\t" "\\t" in
7526 let str = replace_str str "\000" "\\0" in
7529 (* Generate a lot of different functions for guestfish. *)
7530 and generate_fish_cmds () =
7531 generate_header CStyle GPLv2plus;
7535 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7537 let all_functions_sorted =
7539 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7540 ) all_functions_sorted in
7542 pr "#include <config.h>\n";
7544 pr "#include <stdio.h>\n";
7545 pr "#include <stdlib.h>\n";
7546 pr "#include <string.h>\n";
7547 pr "#include <inttypes.h>\n";
7549 pr "#include <guestfs.h>\n";
7550 pr "#include \"c-ctype.h\"\n";
7551 pr "#include \"full-write.h\"\n";
7552 pr "#include \"xstrtol.h\"\n";
7553 pr "#include \"fish.h\"\n";
7555 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7556 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7559 (* list_commands function, which implements guestfish -h *)
7560 pr "void list_commands (void)\n";
7562 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7563 pr " list_builtin_commands ();\n";
7565 fun (name, _, _, flags, _, shortdesc, _) ->
7566 let name = replace_char name '_' '-' in
7567 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7569 ) all_functions_sorted;
7570 pr " printf (\" %%s\\n\",";
7571 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7575 (* display_command function, which implements guestfish -h cmd *)
7576 pr "void display_command (const char *cmd)\n";
7579 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7580 let name2 = replace_char name '_' '-' in
7582 try find_map (function FishAlias n -> Some n | _ -> None) flags
7583 with Not_found -> name in
7584 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7586 match snd style with
7590 name2 (String.concat " " (List.map name_of_argt args)) in
7593 if List.mem ProtocolLimitWarning flags then
7594 ("\n\n" ^ protocol_limit_warning)
7597 (* For DangerWillRobinson commands, we should probably have
7598 * guestfish prompt before allowing you to use them (especially
7599 * in interactive mode). XXX
7603 if List.mem DangerWillRobinson flags then
7604 ("\n\n" ^ danger_will_robinson)
7609 match deprecation_notice flags with
7611 | Some txt -> "\n\n" ^ txt in
7613 let describe_alias =
7614 if name <> alias then
7615 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7619 pr "STRCASEEQ (cmd, \"%s\")" name;
7620 if name <> name2 then
7621 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7622 if name <> alias then
7623 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7625 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7627 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7628 "=head1 DESCRIPTION\n\n" ^
7629 longdesc ^ warnings ^ describe_alias);
7632 pr " display_builtin_command (cmd);\n";
7636 let emit_print_list_function typ =
7637 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7640 pr " unsigned int i;\n";
7642 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7643 pr " printf (\"[%%d] = {\\n\", i);\n";
7644 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7645 pr " printf (\"}\\n\");\n";
7651 (* print_* functions *)
7655 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7657 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7660 pr " unsigned int i;\n";
7666 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7668 pr " printf (\"%%s%s: \", indent);\n" name;
7669 pr " for (i = 0; i < 32; ++i)\n";
7670 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7671 pr " printf (\"\\n\");\n"
7673 pr " printf (\"%%s%s: \", indent);\n" name;
7674 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7675 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7676 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7678 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7679 pr " printf (\"\\n\");\n"
7680 | name, (FUInt64|FBytes) ->
7681 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7684 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7687 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7690 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7693 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7695 | name, FOptPercent ->
7696 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7697 typ name name typ name;
7698 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7704 (* Emit a print_TYPE_list function definition only if that function is used. *)
7707 | typ, (RStructListOnly | RStructAndList) ->
7708 (* generate the function for typ *)
7709 emit_print_list_function typ
7710 | typ, _ -> () (* empty *)
7711 ) (rstructs_used_by all_functions);
7713 (* Emit a print_TYPE function definition only if that function is used. *)
7716 | typ, (RStructOnly | RStructAndList) ->
7717 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7719 pr " print_%s_indent (%s, \"\");\n" typ typ;
7722 | typ, _ -> () (* empty *)
7723 ) (rstructs_used_by all_functions);
7725 (* run_<action> actions *)
7727 fun (name, style, _, flags, _, _, _) ->
7728 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7730 (match fst style with
7733 | RBool _ -> pr " int r;\n"
7734 | RInt64 _ -> pr " int64_t r;\n"
7735 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7736 | RString _ -> pr " char *r;\n"
7737 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7738 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7739 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7742 pr " size_t size;\n";
7748 | OptString n -> pr " const char *%s;\n" n
7752 | FileOut n -> pr " char *%s;\n" n
7754 pr " const char *%s;\n" n;
7755 pr " size_t %s_size;\n" n
7756 | StringList n | DeviceList n -> pr " char **%s;\n" n
7757 | Bool n -> pr " int %s;\n" n
7758 | Int n -> pr " int %s;\n" n
7759 | Int64 n -> pr " int64_t %s;\n" n
7762 (* Check and convert parameters. *)
7763 let argc_expected = List.length (snd style) in
7764 pr " if (argc != %d) {\n" argc_expected;
7765 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7767 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7771 let parse_integer fn fntyp rtyp range name i =
7773 pr " strtol_error xerr;\n";
7774 pr " %s r;\n" fntyp;
7776 pr " xerr = %s (argv[%d], NULL, 0, &r, xstrtol_suffixes);\n" fn i;
7777 pr " if (xerr != LONGINT_OK) {\n";
7778 pr " fprintf (stderr,\n";
7779 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7780 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7785 | Some (min, max, comment) ->
7786 pr " /* %s */\n" comment;
7787 pr " if (r < %s || r > %s) {\n" min max;
7788 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7792 pr " /* The check above should ensure this assignment does not overflow. */\n";
7794 pr " %s = r;\n" name;
7803 pr " %s = argv[%d];\n" name i
7805 | Dev_or_Path name ->
7806 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7807 pr " if (%s == NULL) return -1;\n" name
7809 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7812 pr " %s = argv[%d];\n" name i;
7813 pr " %s_size = strlen (argv[%d]);\n" name i
7815 pr " %s = file_in (argv[%d]);\n" name i;
7816 pr " if (%s == NULL) return -1;\n" name
7818 pr " %s = file_out (argv[%d]);\n" name i;
7819 pr " if (%s == NULL) return -1;\n" name
7820 | StringList name | DeviceList name ->
7821 pr " %s = parse_string_list (argv[%d]);\n" name i;
7822 pr " if (%s == NULL) return -1;\n" name;
7824 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7827 let min = "(-(2LL<<30))"
7828 and max = "((2LL<<30)-1)"
7830 "The Int type in the generator is a signed 31 bit int." in
7831 Some (min, max, comment) in
7832 parse_integer "xstrtoll" "long long" "int" range name i
7834 parse_integer "xstrtoll" "long long" "int64_t" None name i
7837 (* Call C API function. *)
7838 pr " r = guestfs_%s " name;
7839 generate_c_call_args ~handle:"g" style;
7844 | Device name | String name
7845 | OptString name | Bool name
7846 | Int name | Int64 name
7847 | BufferIn name -> ()
7848 | Pathname name | Dev_or_Path name | FileOut name ->
7849 pr " free (%s);\n" name
7851 pr " free_file_in (%s);\n" name
7852 | StringList name | DeviceList name ->
7853 pr " free_strings (%s);\n" name
7856 (* Any output flags? *)
7858 let flags = filter_map (
7859 function FishOutput flag -> Some flag | _ -> None
7865 failwithf "%s: more than one FishOutput flag is not allowed" name in
7867 (* Check return value for errors and display command results. *)
7868 (match fst style with
7869 | RErr -> pr " return r;\n"
7871 pr " if (r == -1) return -1;\n";
7872 (match fish_output with
7874 pr " printf (\"%%d\\n\", r);\n";
7875 | Some FishOutputOctal ->
7876 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7877 | Some FishOutputHexadecimal ->
7878 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7881 pr " if (r == -1) return -1;\n";
7882 (match fish_output with
7884 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7885 | Some FishOutputOctal ->
7886 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7887 | Some FishOutputHexadecimal ->
7888 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7891 pr " if (r == -1) return -1;\n";
7892 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7895 pr " if (r == NULL) return -1;\n";
7896 pr " printf (\"%%s\\n\", r);\n";
7898 | RConstOptString _ ->
7899 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7902 pr " if (r == NULL) return -1;\n";
7903 pr " printf (\"%%s\\n\", r);\n";
7907 pr " if (r == NULL) return -1;\n";
7908 pr " print_strings (r);\n";
7909 pr " free_strings (r);\n";
7911 | RStruct (_, typ) ->
7912 pr " if (r == NULL) return -1;\n";
7913 pr " print_%s (r);\n" typ;
7914 pr " guestfs_free_%s (r);\n" typ;
7916 | RStructList (_, typ) ->
7917 pr " if (r == NULL) return -1;\n";
7918 pr " print_%s_list (r);\n" typ;
7919 pr " guestfs_free_%s_list (r);\n" typ;
7922 pr " if (r == NULL) return -1;\n";
7923 pr " print_table (r);\n";
7924 pr " free_strings (r);\n";
7927 pr " if (r == NULL) return -1;\n";
7928 pr " if (full_write (1, r, size) != size) {\n";
7929 pr " perror (\"write\");\n";
7940 (* run_action function *)
7941 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7944 fun (name, _, _, flags, _, _, _) ->
7945 let name2 = replace_char name '_' '-' in
7947 try find_map (function FishAlias n -> Some n | _ -> None) flags
7948 with Not_found -> name in
7950 pr "STRCASEEQ (cmd, \"%s\")" name;
7951 if name <> name2 then
7952 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7953 if name <> alias then
7954 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7956 pr " return run_%s (cmd, argc, argv);\n" name;
7960 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7961 pr " if (command_num == 1)\n";
7962 pr " extended_help_message ();\n";
7969 (* Readline completion for guestfish. *)
7970 and generate_fish_completion () =
7971 generate_header CStyle GPLv2plus;
7975 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7985 #ifdef HAVE_LIBREADLINE
7986 #include <readline/readline.h>
7991 #ifdef HAVE_LIBREADLINE
7993 static const char *const commands[] = {
7994 BUILTIN_COMMANDS_FOR_COMPLETION,
7997 (* Get the commands, including the aliases. They don't need to be
7998 * sorted - the generator() function just does a dumb linear search.
8002 fun (name, _, _, flags, _, _, _) ->
8003 let name2 = replace_char name '_' '-' in
8005 try find_map (function FishAlias n -> Some n | _ -> None) flags
8006 with Not_found -> name in
8008 if name <> alias then [name2; alias] else [name2]
8010 let commands = List.flatten commands in
8012 List.iter (pr " \"%s\",\n") commands;
8018 generator (const char *text, int state)
8020 static int index, len;
8025 len = strlen (text);
8028 rl_attempted_completion_over = 1;
8030 while ((name = commands[index]) != NULL) {
8032 if (STRCASEEQLEN (name, text, len))
8033 return strdup (name);
8039 #endif /* HAVE_LIBREADLINE */
8041 #ifdef HAVE_RL_COMPLETION_MATCHES
8042 #define RL_COMPLETION_MATCHES rl_completion_matches
8044 #ifdef HAVE_COMPLETION_MATCHES
8045 #define RL_COMPLETION_MATCHES completion_matches
8047 #endif /* else just fail if we don't have either symbol */
8050 do_completion (const char *text, int start, int end)
8052 char **matches = NULL;
8054 #ifdef HAVE_LIBREADLINE
8055 rl_completion_append_character = ' ';
8058 matches = RL_COMPLETION_MATCHES (text, generator);
8059 else if (complete_dest_paths)
8060 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
8067 (* Generate the POD documentation for guestfish. *)
8068 and generate_fish_actions_pod () =
8069 let all_functions_sorted =
8071 fun (_, _, _, flags, _, _, _) ->
8072 not (List.mem NotInFish flags || List.mem NotInDocs flags)
8073 ) all_functions_sorted in
8075 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8078 fun (name, style, _, flags, _, _, longdesc) ->
8080 Str.global_substitute rex (
8083 try Str.matched_group 1 s
8085 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8086 "C<" ^ replace_char sub '_' '-' ^ ">"
8088 let name = replace_char name '_' '-' in
8090 try find_map (function FishAlias n -> Some n | _ -> None) flags
8091 with Not_found -> name in
8093 pr "=head2 %s" name;
8094 if name <> alias then
8101 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
8102 | OptString n -> pr " %s" n
8103 | StringList n | DeviceList n -> pr " '%s ...'" n
8104 | Bool _ -> pr " true|false"
8105 | Int n -> pr " %s" n
8106 | Int64 n -> pr " %s" n
8107 | FileIn n | FileOut n -> pr " (%s|-)" n
8108 | BufferIn n -> pr " %s" n
8112 pr "%s\n\n" longdesc;
8114 if List.exists (function FileIn _ | FileOut _ -> true
8115 | _ -> false) (snd style) then
8116 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8118 if List.mem ProtocolLimitWarning flags then
8119 pr "%s\n\n" protocol_limit_warning;
8121 if List.mem DangerWillRobinson flags then
8122 pr "%s\n\n" danger_will_robinson;
8124 match deprecation_notice flags with
8126 | Some txt -> pr "%s\n\n" txt
8127 ) all_functions_sorted
8129 (* Generate a C function prototype. *)
8130 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8131 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8133 ?handle name style =
8134 if extern then pr "extern ";
8135 if static then pr "static ";
8136 (match fst style with
8138 | RInt _ -> pr "int "
8139 | RInt64 _ -> pr "int64_t "
8140 | RBool _ -> pr "int "
8141 | RConstString _ | RConstOptString _ -> pr "const char *"
8142 | RString _ | RBufferOut _ -> pr "char *"
8143 | RStringList _ | RHashtable _ -> pr "char **"
8144 | RStruct (_, typ) ->
8145 if not in_daemon then pr "struct guestfs_%s *" typ
8146 else pr "guestfs_int_%s *" typ
8147 | RStructList (_, typ) ->
8148 if not in_daemon then pr "struct guestfs_%s_list *" typ
8149 else pr "guestfs_int_%s_list *" typ
8151 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8152 pr "%s%s (" prefix name;
8153 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8156 let comma = ref false in
8159 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8163 if single_line then pr ", " else pr ",\n\t\t"
8170 | Device n | Dev_or_Path n
8174 pr "const char *%s" n
8175 | StringList n | DeviceList n ->
8177 pr "char *const *%s" n
8178 | Bool n -> next (); pr "int %s" n
8179 | Int n -> next (); pr "int %s" n
8180 | Int64 n -> next (); pr "int64_t %s" n
8183 if not in_daemon then (next (); pr "const char *%s" n)
8186 pr "const char *%s" n;
8188 pr "size_t %s_size" n
8190 if is_RBufferOut then (next (); pr "size_t *size_r");
8193 if semicolon then pr ";";
8194 if newline then pr "\n"
8196 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8197 and generate_c_call_args ?handle ?(decl = false) style =
8199 let comma = ref false in
8201 if !comma then pr ", ";
8206 | Some handle -> pr "%s" handle; comma := true
8212 pr "%s, %s_size" n n
8215 pr "%s" (name_of_argt arg)
8217 (* For RBufferOut calls, add implicit &size parameter. *)
8219 match fst style with
8227 (* Generate the OCaml bindings interface. *)
8228 and generate_ocaml_mli () =
8229 generate_header OCamlStyle LGPLv2plus;
8232 (** For API documentation you should refer to the C API
8233 in the guestfs(3) manual page. The OCaml API uses almost
8234 exactly the same calls. *)
8237 (** A [guestfs_h] handle. *)
8239 exception Error of string
8240 (** This exception is raised when there is an error. *)
8242 exception Handle_closed of string
8243 (** This exception is raised if you use a {!Guestfs.t} handle
8244 after calling {!close} on it. The string is the name of
8247 val create : unit -> t
8248 (** Create a {!Guestfs.t} handle. *)
8250 val close : t -> unit
8251 (** Close the {!Guestfs.t} handle and free up all resources used
8254 Handles are closed by the garbage collector when they become
8255 unreferenced, but callers can call this in order to provide
8256 predictable cleanup. *)
8259 generate_ocaml_structure_decls ();
8263 fun (name, style, _, _, _, shortdesc, _) ->
8264 generate_ocaml_prototype name style;
8265 pr "(** %s *)\n" shortdesc;
8267 ) all_functions_sorted
8269 (* Generate the OCaml bindings implementation. *)
8270 and generate_ocaml_ml () =
8271 generate_header OCamlStyle LGPLv2plus;
8276 exception Error of string
8277 exception Handle_closed of string
8279 external create : unit -> t = \"ocaml_guestfs_create\"
8280 external close : t -> unit = \"ocaml_guestfs_close\"
8282 (* Give the exceptions names, so they can be raised from the C code. *)
8284 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8285 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8289 generate_ocaml_structure_decls ();
8293 fun (name, style, _, _, _, shortdesc, _) ->
8294 generate_ocaml_prototype ~is_external:true name style;
8295 ) all_functions_sorted
8297 (* Generate the OCaml bindings C implementation. *)
8298 and generate_ocaml_c () =
8299 generate_header CStyle LGPLv2plus;
8306 #include <caml/config.h>
8307 #include <caml/alloc.h>
8308 #include <caml/callback.h>
8309 #include <caml/fail.h>
8310 #include <caml/memory.h>
8311 #include <caml/mlvalues.h>
8312 #include <caml/signals.h>
8314 #include <guestfs.h>
8316 #include \"guestfs_c.h\"
8318 /* Copy a hashtable of string pairs into an assoc-list. We return
8319 * the list in reverse order, but hashtables aren't supposed to be
8322 static CAMLprim value
8323 copy_table (char * const * argv)
8326 CAMLlocal5 (rv, pairv, kv, vv, cons);
8330 for (i = 0; argv[i] != NULL; i += 2) {
8331 kv = caml_copy_string (argv[i]);
8332 vv = caml_copy_string (argv[i+1]);
8333 pairv = caml_alloc (2, 0);
8334 Store_field (pairv, 0, kv);
8335 Store_field (pairv, 1, vv);
8336 cons = caml_alloc (2, 0);
8337 Store_field (cons, 1, rv);
8339 Store_field (cons, 0, pairv);
8347 (* Struct copy functions. *)
8349 let emit_ocaml_copy_list_function typ =
8350 pr "static CAMLprim value\n";
8351 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8353 pr " CAMLparam0 ();\n";
8354 pr " CAMLlocal2 (rv, v);\n";
8355 pr " unsigned int i;\n";
8357 pr " if (%ss->len == 0)\n" typ;
8358 pr " CAMLreturn (Atom (0));\n";
8360 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8361 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8362 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8363 pr " caml_modify (&Field (rv, i), v);\n";
8365 pr " CAMLreturn (rv);\n";
8373 let has_optpercent_col =
8374 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8376 pr "static CAMLprim value\n";
8377 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8379 pr " CAMLparam0 ();\n";
8380 if has_optpercent_col then
8381 pr " CAMLlocal3 (rv, v, v2);\n"
8383 pr " CAMLlocal2 (rv, v);\n";
8385 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8390 pr " v = caml_copy_string (%s->%s);\n" typ name
8392 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8393 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8396 pr " v = caml_alloc_string (32);\n";
8397 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8398 | name, (FBytes|FInt64|FUInt64) ->
8399 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8400 | name, (FInt32|FUInt32) ->
8401 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8402 | name, FOptPercent ->
8403 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8404 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8405 pr " v = caml_alloc (1, 0);\n";
8406 pr " Store_field (v, 0, v2);\n";
8407 pr " } else /* None */\n";
8408 pr " v = Val_int (0);\n";
8410 pr " v = Val_int (%s->%s);\n" typ name
8412 pr " Store_field (rv, %d, v);\n" i
8414 pr " CAMLreturn (rv);\n";
8419 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8422 | typ, (RStructListOnly | RStructAndList) ->
8423 (* generate the function for typ *)
8424 emit_ocaml_copy_list_function typ
8425 | typ, _ -> () (* empty *)
8426 ) (rstructs_used_by all_functions);
8430 fun (name, style, _, _, _, _, _) ->
8431 pr "/* Automatically generated wrapper for function\n";
8433 generate_ocaml_prototype name style;
8438 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8440 let needs_extra_vs =
8441 match fst style with RConstOptString _ -> true | _ -> false in
8443 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8444 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8445 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8448 pr "CAMLprim value\n";
8449 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8450 List.iter (pr ", value %s") (List.tl params);
8455 | [p1; p2; p3; p4; p5] ->
8456 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8457 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8458 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8459 pr " CAMLxparam%d (%s);\n"
8460 (List.length rest) (String.concat ", " rest)
8462 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8464 if not needs_extra_vs then
8465 pr " CAMLlocal1 (rv);\n"
8467 pr " CAMLlocal3 (rv, v, v2);\n";
8470 pr " guestfs_h *g = Guestfs_val (gv);\n";
8471 pr " if (g == NULL)\n";
8472 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8478 | Device n | Dev_or_Path n
8482 pr " const char *%s = String_val (%sv);\n" n n
8484 pr " const char *%s =\n" n;
8485 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8488 pr " const char *%s = String_val (%sv);\n" n n;
8489 pr " size_t %s_size = caml_string_length (%sv);\n" n n
8490 | StringList n | DeviceList n ->
8491 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8493 pr " int %s = Bool_val (%sv);\n" n n
8495 pr " int %s = Int_val (%sv);\n" n n
8497 pr " int64_t %s = Int64_val (%sv);\n" n n
8500 match fst style with
8501 | RErr -> pr " int r;\n"; "-1"
8502 | RInt _ -> pr " int r;\n"; "-1"
8503 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8504 | RBool _ -> pr " int r;\n"; "-1"
8505 | RConstString _ | RConstOptString _ ->
8506 pr " const char *r;\n"; "NULL"
8507 | RString _ -> pr " char *r;\n"; "NULL"
8512 | RStruct (_, typ) ->
8513 pr " struct guestfs_%s *r;\n" typ; "NULL"
8514 | RStructList (_, typ) ->
8515 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8522 pr " size_t size;\n";
8526 pr " caml_enter_blocking_section ();\n";
8527 pr " r = guestfs_%s " name;
8528 generate_c_call_args ~handle:"g" style;
8530 pr " caml_leave_blocking_section ();\n";
8534 | StringList n | DeviceList n ->
8535 pr " ocaml_guestfs_free_strings (%s);\n" n;
8536 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8537 | Bool _ | Int _ | Int64 _
8538 | FileIn _ | FileOut _ | BufferIn _ -> ()
8541 pr " if (r == %s)\n" error_code;
8542 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8545 (match fst style with
8546 | RErr -> pr " rv = Val_unit;\n"
8547 | RInt _ -> pr " rv = Val_int (r);\n"
8549 pr " rv = caml_copy_int64 (r);\n"
8550 | RBool _ -> pr " rv = Val_bool (r);\n"
8552 pr " rv = caml_copy_string (r);\n"
8553 | RConstOptString _ ->
8554 pr " if (r) { /* Some string */\n";
8555 pr " v = caml_alloc (1, 0);\n";
8556 pr " v2 = caml_copy_string (r);\n";
8557 pr " Store_field (v, 0, v2);\n";
8558 pr " } else /* None */\n";
8559 pr " v = Val_int (0);\n";
8561 pr " rv = caml_copy_string (r);\n";
8564 pr " rv = caml_copy_string_array ((const char **) r);\n";
8565 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8567 | RStruct (_, typ) ->
8568 pr " rv = copy_%s (r);\n" typ;
8569 pr " guestfs_free_%s (r);\n" typ;
8570 | RStructList (_, typ) ->
8571 pr " rv = copy_%s_list (r);\n" typ;
8572 pr " guestfs_free_%s_list (r);\n" typ;
8574 pr " rv = copy_table (r);\n";
8575 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8578 pr " rv = caml_alloc_string (size);\n";
8579 pr " memcpy (String_val (rv), r, size);\n";
8582 pr " CAMLreturn (rv);\n";
8586 if List.length params > 5 then (
8587 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8588 pr "CAMLprim value ";
8589 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8590 pr "CAMLprim value\n";
8591 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8593 pr " return ocaml_guestfs_%s (argv[0]" name;
8594 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8599 ) all_functions_sorted
8601 and generate_ocaml_structure_decls () =
8604 pr "type %s = {\n" typ;
8607 | name, FString -> pr " %s : string;\n" name
8608 | name, FBuffer -> pr " %s : string;\n" name
8609 | name, FUUID -> pr " %s : string;\n" name
8610 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8611 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8612 | name, FChar -> pr " %s : char;\n" name
8613 | name, FOptPercent -> pr " %s : float option;\n" name
8619 and generate_ocaml_prototype ?(is_external = false) name style =
8620 if is_external then pr "external " else pr "val ";
8621 pr "%s : t -> " name;
8624 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8625 | BufferIn _ -> pr "string -> "
8626 | OptString _ -> pr "string option -> "
8627 | StringList _ | DeviceList _ -> pr "string array -> "
8628 | Bool _ -> pr "bool -> "
8629 | Int _ -> pr "int -> "
8630 | Int64 _ -> pr "int64 -> "
8632 (match fst style with
8633 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8634 | RInt _ -> pr "int"
8635 | RInt64 _ -> pr "int64"
8636 | RBool _ -> pr "bool"
8637 | RConstString _ -> pr "string"
8638 | RConstOptString _ -> pr "string option"
8639 | RString _ | RBufferOut _ -> pr "string"
8640 | RStringList _ -> pr "string array"
8641 | RStruct (_, typ) -> pr "%s" typ
8642 | RStructList (_, typ) -> pr "%s array" typ
8643 | RHashtable _ -> pr "(string * string) list"
8645 if is_external then (
8647 if List.length (snd style) + 1 > 5 then
8648 pr "\"ocaml_guestfs_%s_byte\" " name;
8649 pr "\"ocaml_guestfs_%s\"" name
8653 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8654 and generate_perl_xs () =
8655 generate_header CStyle LGPLv2plus;
8658 #include \"EXTERN.h\"
8662 #include <guestfs.h>
8665 #define PRId64 \"lld\"
8669 my_newSVll(long long val) {
8670 #ifdef USE_64_BIT_ALL
8671 return newSViv(val);
8675 len = snprintf(buf, 100, \"%%\" PRId64, val);
8676 return newSVpv(buf, len);
8681 #define PRIu64 \"llu\"
8685 my_newSVull(unsigned long long val) {
8686 #ifdef USE_64_BIT_ALL
8687 return newSVuv(val);
8691 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8692 return newSVpv(buf, len);
8696 /* http://www.perlmonks.org/?node_id=680842 */
8698 XS_unpack_charPtrPtr (SV *arg) {
8703 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8704 croak (\"array reference expected\");
8706 av = (AV *)SvRV (arg);
8707 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8709 croak (\"malloc failed\");
8711 for (i = 0; i <= av_len (av); i++) {
8712 SV **elem = av_fetch (av, i, 0);
8714 if (!elem || !*elem)
8715 croak (\"missing element in list\");
8717 ret[i] = SvPV_nolen (*elem);
8725 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8732 RETVAL = guestfs_create ();
8734 croak (\"could not create guestfs handle\");
8735 guestfs_set_error_handler (RETVAL, NULL, NULL);
8748 fun (name, style, _, _, _, _, _) ->
8749 (match fst style with
8750 | RErr -> pr "void\n"
8751 | RInt _ -> pr "SV *\n"
8752 | RInt64 _ -> pr "SV *\n"
8753 | RBool _ -> pr "SV *\n"
8754 | RConstString _ -> pr "SV *\n"
8755 | RConstOptString _ -> pr "SV *\n"
8756 | RString _ -> pr "SV *\n"
8757 | RBufferOut _ -> pr "SV *\n"
8759 | RStruct _ | RStructList _
8761 pr "void\n" (* all lists returned implictly on the stack *)
8763 (* Call and arguments. *)
8766 fun arg -> pr ", %s" (name_of_argt arg)
8769 pr " guestfs_h *g;\n";
8773 | Pathname n | Device n | Dev_or_Path n | String n
8774 | FileIn n | FileOut n ->
8777 pr " char *%s;\n" n;
8778 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
8780 (* http://www.perlmonks.org/?node_id=554277
8781 * Note that the implicit handle argument means we have
8782 * to add 1 to the ST(x) operator.
8784 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8785 | StringList n | DeviceList n -> pr " char **%s;\n" n
8786 | Bool n -> pr " int %s;\n" n
8787 | Int n -> pr " int %s;\n" n
8788 | Int64 n -> pr " int64_t %s;\n" n
8791 let do_cleanups () =
8794 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8795 | Bool _ | Int _ | Int64 _
8796 | FileIn _ | FileOut _
8798 | StringList n | DeviceList n -> pr " free (%s);\n" n
8803 (match fst style with
8808 pr " r = guestfs_%s " name;
8809 generate_c_call_args ~handle:"g" style;
8812 pr " if (r == -1)\n";
8813 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8819 pr " %s = guestfs_%s " n name;
8820 generate_c_call_args ~handle:"g" style;
8823 pr " if (%s == -1)\n" n;
8824 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8825 pr " RETVAL = newSViv (%s);\n" n;
8830 pr " int64_t %s;\n" n;
8832 pr " %s = guestfs_%s " n name;
8833 generate_c_call_args ~handle:"g" style;
8836 pr " if (%s == -1)\n" n;
8837 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8838 pr " RETVAL = my_newSVll (%s);\n" n;
8843 pr " const char *%s;\n" n;
8845 pr " %s = guestfs_%s " n name;
8846 generate_c_call_args ~handle:"g" style;
8849 pr " if (%s == NULL)\n" n;
8850 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8851 pr " RETVAL = newSVpv (%s, 0);\n" n;
8854 | RConstOptString n ->
8856 pr " const char *%s;\n" n;
8858 pr " %s = guestfs_%s " n name;
8859 generate_c_call_args ~handle:"g" style;
8862 pr " if (%s == NULL)\n" n;
8863 pr " RETVAL = &PL_sv_undef;\n";
8865 pr " RETVAL = newSVpv (%s, 0);\n" n;
8870 pr " char *%s;\n" n;
8872 pr " %s = guestfs_%s " n name;
8873 generate_c_call_args ~handle:"g" style;
8876 pr " if (%s == NULL)\n" n;
8877 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8878 pr " RETVAL = newSVpv (%s, 0);\n" n;
8879 pr " free (%s);\n" n;
8882 | RStringList n | RHashtable n ->
8884 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 " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8894 pr " EXTEND (SP, n);\n";
8895 pr " for (i = 0; i < n; ++i) {\n";
8896 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8897 pr " free (%s[i]);\n" n;
8899 pr " free (%s);\n" n;
8900 | RStruct (n, typ) ->
8901 let cols = cols_of_struct typ in
8902 generate_perl_struct_code typ cols name style n do_cleanups
8903 | RStructList (n, typ) ->
8904 let cols = cols_of_struct typ in
8905 generate_perl_struct_list_code typ cols name style n do_cleanups
8908 pr " char *%s;\n" n;
8909 pr " size_t size;\n";
8911 pr " %s = guestfs_%s " n name;
8912 generate_c_call_args ~handle:"g" style;
8915 pr " if (%s == NULL)\n" n;
8916 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8917 pr " RETVAL = newSVpvn (%s, size);\n" n;
8918 pr " free (%s);\n" n;
8926 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8928 pr " struct guestfs_%s_list *%s;\n" typ n;
8932 pr " %s = guestfs_%s " n name;
8933 generate_c_call_args ~handle:"g" style;
8936 pr " if (%s == NULL)\n" n;
8937 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8938 pr " EXTEND (SP, %s->len);\n" n;
8939 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8940 pr " hv = newHV ();\n";
8944 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8945 name (String.length name) n name
8947 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8948 name (String.length name) n name
8950 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8951 name (String.length name) n name n name
8952 | name, (FBytes|FUInt64) ->
8953 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8954 name (String.length name) n name
8956 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8957 name (String.length name) n name
8958 | name, (FInt32|FUInt32) ->
8959 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8960 name (String.length name) n name
8962 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8963 name (String.length name) n name
8964 | name, FOptPercent ->
8965 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8966 name (String.length name) n name
8968 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8970 pr " guestfs_free_%s_list (%s);\n" typ n
8972 and generate_perl_struct_code typ cols name style n do_cleanups =
8974 pr " struct guestfs_%s *%s;\n" typ n;
8976 pr " %s = guestfs_%s " n name;
8977 generate_c_call_args ~handle:"g" style;
8980 pr " if (%s == NULL)\n" n;
8981 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8982 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8984 fun ((name, _) as col) ->
8985 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8989 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8992 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
8995 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8997 | name, (FBytes|FUInt64) ->
8998 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
9001 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
9003 | name, (FInt32|FUInt32) ->
9004 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9007 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
9009 | name, FOptPercent ->
9010 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9013 pr " free (%s);\n" n
9015 (* Generate Sys/Guestfs.pm. *)
9016 and generate_perl_pm () =
9017 generate_header HashStyle LGPLv2plus;
9024 Sys::Guestfs - Perl bindings for libguestfs
9030 my $h = Sys::Guestfs->new ();
9031 $h->add_drive ('guest.img');
9033 $h->mount ('/dev/sda1', '/');
9034 $h->touch ('/hello');
9039 The C<Sys::Guestfs> module provides a Perl XS binding to the
9040 libguestfs API for examining and modifying virtual machine
9043 Amongst the things this is good for: making batch configuration
9044 changes to guests, getting disk used/free statistics (see also:
9045 virt-df), migrating between virtualization systems (see also:
9046 virt-p2v), performing partial backups, performing partial guest
9047 clones, cloning guests and changing registry/UUID/hostname info, and
9050 Libguestfs uses Linux kernel and qemu code, and can access any type of
9051 guest filesystem that Linux and qemu can, including but not limited
9052 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9053 schemes, qcow, qcow2, vmdk.
9055 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9056 LVs, what filesystem is in each LV, etc.). It can also run commands
9057 in the context of the guest. Also you can access filesystems over
9060 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
9061 functions for using libguestfs from Perl, including integration
9066 All errors turn into calls to C<croak> (see L<Carp(3)>).
9074 package Sys::Guestfs;
9079 # This version number changes whenever a new function
9080 # is added to the libguestfs API. It is not directly
9081 # related to the libguestfs version number.
9082 use vars qw($VERSION);
9086 XSLoader::load ('Sys::Guestfs');
9088 =item $h = Sys::Guestfs->new ();
9090 Create a new guestfs handle.
9096 my $class = ref ($proto) || $proto;
9098 my $self = Sys::Guestfs::_create ();
9099 bless $self, $class;
9105 (* Actions. We only need to print documentation for these as
9106 * they are pulled in from the XS code automatically.
9109 fun (name, style, _, flags, _, _, longdesc) ->
9110 if not (List.mem NotInDocs flags) then (
9111 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9113 generate_perl_prototype name style;
9115 pr "%s\n\n" longdesc;
9116 if List.mem ProtocolLimitWarning flags then
9117 pr "%s\n\n" protocol_limit_warning;
9118 if List.mem DangerWillRobinson flags then
9119 pr "%s\n\n" danger_will_robinson;
9120 match deprecation_notice flags with
9122 | Some txt -> pr "%s\n\n" txt
9124 ) all_functions_sorted;
9136 Copyright (C) %s Red Hat Inc.
9140 Please see the file COPYING.LIB for the full license.
9146 L<http://libguestfs.org>,
9147 L<Sys::Guestfs::Lib(3)>.
9152 and generate_perl_prototype name style =
9153 (match fst style with
9161 | RBufferOut n -> pr "$%s = " n
9163 | RHashtable n -> pr "%%%s = " n
9165 | RStructList (n,_) -> pr "@%s = " n
9168 let comma = ref false in
9171 if !comma then pr ", ";
9174 | Pathname n | Device n | Dev_or_Path n | String n
9175 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9178 | StringList n | DeviceList n ->
9183 (* Generate Python C module. *)
9184 and generate_python_c () =
9185 generate_header CStyle LGPLv2plus;
9188 #define PY_SSIZE_T_CLEAN 1
9191 #if PY_VERSION_HEX < 0x02050000
9192 typedef int Py_ssize_t;
9193 #define PY_SSIZE_T_MAX INT_MAX
9194 #define PY_SSIZE_T_MIN INT_MIN
9201 #include \"guestfs.h\"
9209 get_handle (PyObject *obj)
9212 assert (obj != Py_None);
9213 return ((Pyguestfs_Object *) obj)->g;
9217 put_handle (guestfs_h *g)
9221 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9224 /* This list should be freed (but not the strings) after use. */
9226 get_string_list (PyObject *obj)
9233 if (!PyList_Check (obj)) {
9234 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9238 len = PyList_Size (obj);
9239 r = malloc (sizeof (char *) * (len+1));
9241 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9245 for (i = 0; i < len; ++i)
9246 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9253 put_string_list (char * const * const argv)
9258 for (argc = 0; argv[argc] != NULL; ++argc)
9261 list = PyList_New (argc);
9262 for (i = 0; i < argc; ++i)
9263 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9269 put_table (char * const * const argv)
9271 PyObject *list, *item;
9274 for (argc = 0; argv[argc] != NULL; ++argc)
9277 list = PyList_New (argc >> 1);
9278 for (i = 0; i < argc; i += 2) {
9279 item = PyTuple_New (2);
9280 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9281 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9282 PyList_SetItem (list, i >> 1, item);
9289 free_strings (char **argv)
9293 for (argc = 0; argv[argc] != NULL; ++argc)
9299 py_guestfs_create (PyObject *self, PyObject *args)
9303 g = guestfs_create ();
9305 PyErr_SetString (PyExc_RuntimeError,
9306 \"guestfs.create: failed to allocate handle\");
9309 guestfs_set_error_handler (g, NULL, NULL);
9310 return put_handle (g);
9314 py_guestfs_close (PyObject *self, PyObject *args)
9319 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9321 g = get_handle (py_g);
9325 Py_INCREF (Py_None);
9331 let emit_put_list_function typ =
9332 pr "static PyObject *\n";
9333 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9335 pr " PyObject *list;\n";
9338 pr " list = PyList_New (%ss->len);\n" typ;
9339 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9340 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9341 pr " return list;\n";
9346 (* Structures, turned into Python dictionaries. *)
9349 pr "static PyObject *\n";
9350 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9352 pr " PyObject *dict;\n";
9354 pr " dict = PyDict_New ();\n";
9358 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9359 pr " PyString_FromString (%s->%s));\n"
9362 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9363 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9366 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9367 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9369 | name, (FBytes|FUInt64) ->
9370 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9371 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9374 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9375 pr " PyLong_FromLongLong (%s->%s));\n"
9378 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9379 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9382 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9383 pr " PyLong_FromLong (%s->%s));\n"
9385 | name, FOptPercent ->
9386 pr " if (%s->%s >= 0)\n" typ name;
9387 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9388 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9391 pr " Py_INCREF (Py_None);\n";
9392 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9395 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9396 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9398 pr " return dict;\n";
9404 (* Emit a put_TYPE_list function definition only if that function is used. *)
9407 | typ, (RStructListOnly | RStructAndList) ->
9408 (* generate the function for typ *)
9409 emit_put_list_function typ
9410 | typ, _ -> () (* empty *)
9411 ) (rstructs_used_by all_functions);
9413 (* Python wrapper functions. *)
9415 fun (name, style, _, _, _, _, _) ->
9416 pr "static PyObject *\n";
9417 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9420 pr " PyObject *py_g;\n";
9421 pr " guestfs_h *g;\n";
9422 pr " PyObject *py_r;\n";
9425 match fst style with
9426 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9427 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9428 | RConstString _ | RConstOptString _ ->
9429 pr " const char *r;\n"; "NULL"
9430 | RString _ -> pr " char *r;\n"; "NULL"
9431 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9432 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9433 | RStructList (_, typ) ->
9434 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9437 pr " size_t size;\n";
9442 | Pathname n | Device n | Dev_or_Path n | String n
9443 | FileIn n | FileOut n ->
9444 pr " const char *%s;\n" n
9445 | OptString n -> pr " const char *%s;\n" n
9447 pr " const char *%s;\n" n;
9448 pr " Py_ssize_t %s_size;\n" n
9449 | StringList n | DeviceList n ->
9450 pr " PyObject *py_%s;\n" n;
9451 pr " char **%s;\n" n
9452 | Bool n -> pr " int %s;\n" n
9453 | Int n -> pr " int %s;\n" n
9454 | Int64 n -> pr " long long %s;\n" n
9459 (* Convert the parameters. *)
9460 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9463 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9464 | OptString _ -> pr "z"
9465 | StringList _ | DeviceList _ -> pr "O"
9466 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9468 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9469 * emulate C's int/long/long long in Python?
9471 | BufferIn _ -> pr "s#"
9473 pr ":guestfs_%s\",\n" name;
9477 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9478 | OptString n -> pr ", &%s" n
9479 | StringList n | DeviceList n -> pr ", &py_%s" n
9480 | Bool n -> pr ", &%s" n
9481 | Int n -> pr ", &%s" n
9482 | Int64 n -> pr ", &%s" n
9483 | BufferIn n -> pr ", &%s, &%s_size" n n
9487 pr " return NULL;\n";
9489 pr " g = get_handle (py_g);\n";
9492 | Pathname _ | Device _ | Dev_or_Path _ | String _
9493 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9495 | StringList n | DeviceList n ->
9496 pr " %s = get_string_list (py_%s);\n" n n;
9497 pr " if (!%s) return NULL;\n" n
9502 pr " r = guestfs_%s " name;
9503 generate_c_call_args ~handle:"g" style;
9508 | Pathname _ | Device _ | Dev_or_Path _ | String _
9509 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9511 | StringList n | DeviceList n ->
9512 pr " free (%s);\n" n
9515 pr " if (r == %s) {\n" error_code;
9516 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9517 pr " return NULL;\n";
9521 (match fst style with
9523 pr " Py_INCREF (Py_None);\n";
9524 pr " py_r = Py_None;\n"
9526 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9527 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9528 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9529 | RConstOptString _ ->
9531 pr " py_r = PyString_FromString (r);\n";
9533 pr " Py_INCREF (Py_None);\n";
9534 pr " py_r = Py_None;\n";
9537 pr " py_r = PyString_FromString (r);\n";
9540 pr " py_r = put_string_list (r);\n";
9541 pr " free_strings (r);\n"
9542 | RStruct (_, typ) ->
9543 pr " py_r = put_%s (r);\n" typ;
9544 pr " guestfs_free_%s (r);\n" typ
9545 | RStructList (_, typ) ->
9546 pr " py_r = put_%s_list (r);\n" typ;
9547 pr " guestfs_free_%s_list (r);\n" typ
9549 pr " py_r = put_table (r);\n";
9550 pr " free_strings (r);\n"
9552 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9556 pr " return py_r;\n";
9561 (* Table of functions. *)
9562 pr "static PyMethodDef methods[] = {\n";
9563 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9564 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9566 fun (name, _, _, _, _, _, _) ->
9567 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9570 pr " { NULL, NULL, 0, NULL }\n";
9574 (* Init function. *)
9577 initlibguestfsmod (void)
9579 static int initialized = 0;
9581 if (initialized) return;
9582 Py_InitModule ((char *) \"libguestfsmod\", methods);
9587 (* Generate Python module. *)
9588 and generate_python_py () =
9589 generate_header HashStyle LGPLv2plus;
9592 u\"\"\"Python bindings for libguestfs
9595 g = guestfs.GuestFS ()
9596 g.add_drive (\"guest.img\")
9598 parts = g.list_partitions ()
9600 The guestfs module provides a Python binding to the libguestfs API
9601 for examining and modifying virtual machine disk images.
9603 Amongst the things this is good for: making batch configuration
9604 changes to guests, getting disk used/free statistics (see also:
9605 virt-df), migrating between virtualization systems (see also:
9606 virt-p2v), performing partial backups, performing partial guest
9607 clones, cloning guests and changing registry/UUID/hostname info, and
9610 Libguestfs uses Linux kernel and qemu code, and can access any type of
9611 guest filesystem that Linux and qemu can, including but not limited
9612 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9613 schemes, qcow, qcow2, vmdk.
9615 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9616 LVs, what filesystem is in each LV, etc.). It can also run commands
9617 in the context of the guest. Also you can access filesystems over
9620 Errors which happen while using the API are turned into Python
9621 RuntimeError exceptions.
9623 To create a guestfs handle you usually have to perform the following
9626 # Create the handle, call add_drive at least once, and possibly
9627 # several times if the guest has multiple block devices:
9628 g = guestfs.GuestFS ()
9629 g.add_drive (\"guest.img\")
9631 # Launch the qemu subprocess and wait for it to become ready:
9634 # Now you can issue commands, for example:
9639 import libguestfsmod
9642 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9644 def __init__ (self):
9645 \"\"\"Create a new libguestfs handle.\"\"\"
9646 self._o = libguestfsmod.create ()
9649 libguestfsmod.close (self._o)
9654 fun (name, style, _, flags, _, _, longdesc) ->
9656 generate_py_call_args ~handle:"self" (snd style);
9659 if not (List.mem NotInDocs flags) then (
9660 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9662 match fst style with
9663 | RErr | RInt _ | RInt64 _ | RBool _
9664 | RConstOptString _ | RConstString _
9665 | RString _ | RBufferOut _ -> doc
9667 doc ^ "\n\nThis function returns a list of strings."
9668 | RStruct (_, typ) ->
9669 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9670 | RStructList (_, typ) ->
9671 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9673 doc ^ "\n\nThis function returns a dictionary." in
9675 if List.mem ProtocolLimitWarning flags then
9676 doc ^ "\n\n" ^ protocol_limit_warning
9679 if List.mem DangerWillRobinson flags then
9680 doc ^ "\n\n" ^ danger_will_robinson
9683 match deprecation_notice flags with
9685 | Some txt -> doc ^ "\n\n" ^ txt in
9686 let doc = pod2text ~width:60 name doc in
9687 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9688 let doc = String.concat "\n " doc in
9689 pr " u\"\"\"%s\"\"\"\n" doc;
9691 pr " return libguestfsmod.%s " name;
9692 generate_py_call_args ~handle:"self._o" (snd style);
9697 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9698 and generate_py_call_args ~handle args =
9700 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9703 (* Useful if you need the longdesc POD text as plain text. Returns a
9706 * Because this is very slow (the slowest part of autogeneration),
9707 * we memoize the results.
9709 and pod2text ~width name longdesc =
9710 let key = width, name, longdesc in
9711 try Hashtbl.find pod2text_memo key
9713 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9714 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9716 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9717 let chan = open_process_in cmd in
9718 let lines = ref [] in
9720 let line = input_line chan in
9721 if i = 1 then (* discard the first line of output *)
9724 let line = triml line in
9725 lines := line :: !lines;
9728 let lines = try loop 1 with End_of_file -> List.rev !lines in
9730 (match close_process_in chan with
9733 failwithf "pod2text: process exited with non-zero status (%d)" i
9734 | WSIGNALED i | WSTOPPED i ->
9735 failwithf "pod2text: process signalled or stopped by signal %d" i
9737 Hashtbl.add pod2text_memo key lines;
9738 pod2text_memo_updated ();
9741 (* Generate ruby bindings. *)
9742 and generate_ruby_c () =
9743 generate_header CStyle LGPLv2plus;
9751 #include \"guestfs.h\"
9753 #include \"extconf.h\"
9755 /* For Ruby < 1.9 */
9757 #define RARRAY_LEN(r) (RARRAY((r))->len)
9760 static VALUE m_guestfs; /* guestfs module */
9761 static VALUE c_guestfs; /* guestfs_h handle */
9762 static VALUE e_Error; /* used for all errors */
9764 static void ruby_guestfs_free (void *p)
9767 guestfs_close ((guestfs_h *) p);
9770 static VALUE ruby_guestfs_create (VALUE m)
9774 g = guestfs_create ();
9776 rb_raise (e_Error, \"failed to create guestfs handle\");
9778 /* Don't print error messages to stderr by default. */
9779 guestfs_set_error_handler (g, NULL, NULL);
9781 /* Wrap it, and make sure the close function is called when the
9784 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9787 static VALUE ruby_guestfs_close (VALUE gv)
9790 Data_Get_Struct (gv, guestfs_h, g);
9792 ruby_guestfs_free (g);
9793 DATA_PTR (gv) = NULL;
9801 fun (name, style, _, _, _, _, _) ->
9802 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9803 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9806 pr " guestfs_h *g;\n";
9807 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9809 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9815 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9816 pr " Check_Type (%sv, T_STRING);\n" n;
9817 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9819 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9820 pr " \"%s\", \"%s\");\n" n name
9822 pr " Check_Type (%sv, T_STRING);\n" n;
9823 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
9825 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9826 pr " \"%s\", \"%s\");\n" n name;
9827 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
9829 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9830 | StringList n | DeviceList n ->
9831 pr " char **%s;\n" n;
9832 pr " Check_Type (%sv, T_ARRAY);\n" n;
9834 pr " int i, len;\n";
9835 pr " len = RARRAY_LEN (%sv);\n" n;
9836 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9838 pr " for (i = 0; i < len; ++i) {\n";
9839 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9840 pr " %s[i] = StringValueCStr (v);\n" n;
9842 pr " %s[len] = NULL;\n" n;
9845 pr " int %s = RTEST (%sv);\n" n n
9847 pr " int %s = NUM2INT (%sv);\n" n n
9849 pr " long long %s = NUM2LL (%sv);\n" n n
9854 match fst style with
9855 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9856 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9857 | RConstString _ | RConstOptString _ ->
9858 pr " const char *r;\n"; "NULL"
9859 | RString _ -> pr " char *r;\n"; "NULL"
9860 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9861 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9862 | RStructList (_, typ) ->
9863 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9866 pr " size_t size;\n";
9870 pr " r = guestfs_%s " name;
9871 generate_c_call_args ~handle:"g" style;
9876 | Pathname _ | Device _ | Dev_or_Path _ | String _
9877 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9879 | StringList n | DeviceList n ->
9880 pr " free (%s);\n" n
9883 pr " if (r == %s)\n" error_code;
9884 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9887 (match fst style with
9889 pr " return Qnil;\n"
9890 | RInt _ | RBool _ ->
9891 pr " return INT2NUM (r);\n"
9893 pr " return ULL2NUM (r);\n"
9895 pr " return rb_str_new2 (r);\n";
9896 | RConstOptString _ ->
9898 pr " return rb_str_new2 (r);\n";
9900 pr " return Qnil;\n";
9902 pr " VALUE rv = rb_str_new2 (r);\n";
9906 pr " int i, len = 0;\n";
9907 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9908 pr " VALUE rv = rb_ary_new2 (len);\n";
9909 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9910 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9911 pr " free (r[i]);\n";
9915 | RStruct (_, typ) ->
9916 let cols = cols_of_struct typ in
9917 generate_ruby_struct_code typ cols
9918 | RStructList (_, typ) ->
9919 let cols = cols_of_struct typ in
9920 generate_ruby_struct_list_code typ cols
9922 pr " VALUE rv = rb_hash_new ();\n";
9924 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9925 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9926 pr " free (r[i]);\n";
9927 pr " free (r[i+1]);\n";
9932 pr " VALUE rv = rb_str_new (r, size);\n";
9942 /* Initialize the module. */
9943 void Init__guestfs ()
9945 m_guestfs = rb_define_module (\"Guestfs\");
9946 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9947 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9949 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9950 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9953 (* Define the rest of the methods. *)
9955 fun (name, style, _, _, _, _, _) ->
9956 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9957 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9962 (* Ruby code to return a struct. *)
9963 and generate_ruby_struct_code typ cols =
9964 pr " VALUE rv = rb_hash_new ();\n";
9968 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9970 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9972 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9973 | name, (FBytes|FUInt64) ->
9974 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9976 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9978 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9980 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9981 | name, FOptPercent ->
9982 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9983 | name, FChar -> (* XXX wrong? *)
9984 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9986 pr " guestfs_free_%s (r);\n" typ;
9989 (* Ruby code to return a struct list. *)
9990 and generate_ruby_struct_list_code typ cols =
9991 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9993 pr " for (i = 0; i < r->len; ++i) {\n";
9994 pr " VALUE hv = rb_hash_new ();\n";
9998 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
10000 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
10002 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
10003 | name, (FBytes|FUInt64) ->
10004 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10006 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
10008 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
10010 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
10011 | name, FOptPercent ->
10012 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
10013 | name, FChar -> (* XXX wrong? *)
10014 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10016 pr " rb_ary_push (rv, hv);\n";
10018 pr " guestfs_free_%s_list (r);\n" typ;
10021 (* Generate Java bindings GuestFS.java file. *)
10022 and generate_java_java () =
10023 generate_header CStyle LGPLv2plus;
10026 package com.redhat.et.libguestfs;
10028 import java.util.HashMap;
10029 import com.redhat.et.libguestfs.LibGuestFSException;
10030 import com.redhat.et.libguestfs.PV;
10031 import com.redhat.et.libguestfs.VG;
10032 import com.redhat.et.libguestfs.LV;
10033 import com.redhat.et.libguestfs.Stat;
10034 import com.redhat.et.libguestfs.StatVFS;
10035 import com.redhat.et.libguestfs.IntBool;
10036 import com.redhat.et.libguestfs.Dirent;
10039 * The GuestFS object is a libguestfs handle.
10043 public class GuestFS {
10044 // Load the native code.
10046 System.loadLibrary (\"guestfs_jni\");
10050 * The native guestfs_h pointer.
10055 * Create a libguestfs handle.
10057 * @throws LibGuestFSException
10059 public GuestFS () throws LibGuestFSException
10063 private native long _create () throws LibGuestFSException;
10066 * Close a libguestfs handle.
10068 * You can also leave handles to be collected by the garbage
10069 * collector, but this method ensures that the resources used
10070 * by the handle are freed up immediately. If you call any
10071 * other methods after closing the handle, you will get an
10074 * @throws LibGuestFSException
10076 public void close () throws LibGuestFSException
10082 private native void _close (long g) throws LibGuestFSException;
10084 public void finalize () throws LibGuestFSException
10092 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10093 if not (List.mem NotInDocs flags); then (
10094 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10096 if List.mem ProtocolLimitWarning flags then
10097 doc ^ "\n\n" ^ protocol_limit_warning
10100 if List.mem DangerWillRobinson flags then
10101 doc ^ "\n\n" ^ danger_will_robinson
10104 match deprecation_notice flags with
10106 | Some txt -> doc ^ "\n\n" ^ txt in
10107 let doc = pod2text ~width:60 name doc in
10108 let doc = List.map ( (* RHBZ#501883 *)
10111 | nonempty -> nonempty
10113 let doc = String.concat "\n * " doc in
10116 pr " * %s\n" shortdesc;
10119 pr " * @throws LibGuestFSException\n";
10123 generate_java_prototype ~public:true ~semicolon:false name style;
10126 pr " if (g == 0)\n";
10127 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10130 if fst style <> RErr then pr "return ";
10132 generate_java_call_args ~handle:"g" (snd style);
10136 generate_java_prototype ~privat:true ~native:true name style;
10143 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10144 and generate_java_call_args ~handle args =
10146 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10149 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10150 ?(semicolon=true) name style =
10151 if privat then pr "private ";
10152 if public then pr "public ";
10153 if native then pr "native ";
10156 (match fst style with
10157 | RErr -> pr "void ";
10158 | RInt _ -> pr "int ";
10159 | RInt64 _ -> pr "long ";
10160 | RBool _ -> pr "boolean ";
10161 | RConstString _ | RConstOptString _ | RString _
10162 | RBufferOut _ -> pr "String ";
10163 | RStringList _ -> pr "String[] ";
10164 | RStruct (_, typ) ->
10165 let name = java_name_of_struct typ in
10167 | RStructList (_, typ) ->
10168 let name = java_name_of_struct typ in
10170 | RHashtable _ -> pr "HashMap<String,String> ";
10173 if native then pr "_%s " name else pr "%s " name;
10175 let needs_comma = ref false in
10178 needs_comma := true
10184 if !needs_comma then pr ", ";
10185 needs_comma := true;
10189 | Device n | Dev_or_Path n
10197 | StringList n | DeviceList n ->
10208 pr " throws LibGuestFSException";
10209 if semicolon then pr ";"
10211 and generate_java_struct jtyp cols () =
10212 generate_header CStyle LGPLv2plus;
10215 package com.redhat.et.libguestfs;
10218 * Libguestfs %s structure.
10230 | name, FBuffer -> pr " public String %s;\n" name
10231 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10232 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10233 | name, FChar -> pr " public char %s;\n" name
10234 | name, FOptPercent ->
10235 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10236 pr " public float %s;\n" name
10241 and generate_java_c () =
10242 generate_header CStyle LGPLv2plus;
10246 #include <stdlib.h>
10247 #include <string.h>
10249 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10250 #include \"guestfs.h\"
10252 /* Note that this function returns. The exception is not thrown
10253 * until after the wrapper function returns.
10256 throw_exception (JNIEnv *env, const char *msg)
10259 cl = (*env)->FindClass (env,
10260 \"com/redhat/et/libguestfs/LibGuestFSException\");
10261 (*env)->ThrowNew (env, cl, msg);
10264 JNIEXPORT jlong JNICALL
10265 Java_com_redhat_et_libguestfs_GuestFS__1create
10266 (JNIEnv *env, jobject obj)
10270 g = guestfs_create ();
10272 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10275 guestfs_set_error_handler (g, NULL, NULL);
10276 return (jlong) (long) g;
10279 JNIEXPORT void JNICALL
10280 Java_com_redhat_et_libguestfs_GuestFS__1close
10281 (JNIEnv *env, jobject obj, jlong jg)
10283 guestfs_h *g = (guestfs_h *) (long) jg;
10290 fun (name, style, _, _, _, _, _) ->
10292 (match fst style with
10293 | RErr -> pr "void ";
10294 | RInt _ -> pr "jint ";
10295 | RInt64 _ -> pr "jlong ";
10296 | RBool _ -> pr "jboolean ";
10297 | RConstString _ | RConstOptString _ | RString _
10298 | RBufferOut _ -> pr "jstring ";
10299 | RStruct _ | RHashtable _ ->
10301 | RStringList _ | RStructList _ ->
10302 pr "jobjectArray ";
10305 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10306 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10308 pr " (JNIEnv *env, jobject obj, jlong jg";
10312 | Device n | Dev_or_Path n
10317 pr ", jstring j%s" n
10319 pr ", jbyteArray j%s" n
10320 | StringList n | DeviceList n ->
10321 pr ", jobjectArray j%s" n
10323 pr ", jboolean j%s" n
10331 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10332 let error_code, no_ret =
10333 match fst style with
10334 | RErr -> pr " int r;\n"; "-1", ""
10336 | RInt _ -> pr " int r;\n"; "-1", "0"
10337 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10338 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10339 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10341 pr " jstring jr;\n";
10342 pr " char *r;\n"; "NULL", "NULL"
10344 pr " jobjectArray jr;\n";
10345 pr " int r_len;\n";
10346 pr " jclass cl;\n";
10347 pr " jstring jstr;\n";
10348 pr " char **r;\n"; "NULL", "NULL"
10349 | RStruct (_, typ) ->
10350 pr " jobject jr;\n";
10351 pr " jclass cl;\n";
10352 pr " jfieldID fl;\n";
10353 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10354 | RStructList (_, typ) ->
10355 pr " jobjectArray jr;\n";
10356 pr " jclass cl;\n";
10357 pr " jfieldID fl;\n";
10358 pr " jobject jfl;\n";
10359 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10360 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10362 pr " jstring jr;\n";
10364 pr " size_t size;\n";
10369 | Device n | Dev_or_Path n
10374 pr " const char *%s;\n" n
10376 pr " jbyte *%s;\n" n;
10377 pr " size_t %s_size;\n" n
10378 | StringList n | DeviceList n ->
10379 pr " int %s_len;\n" n;
10380 pr " const char **%s;\n" n
10385 pr " int64_t %s;\n" n
10389 (match fst style with
10390 | RStringList _ | RStructList _ -> true
10391 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10392 | RConstOptString _
10393 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10394 List.exists (function
10395 | StringList _ -> true
10396 | DeviceList _ -> true
10397 | _ -> false) (snd style) in
10403 (* Get the parameters. *)
10407 | Device n | Dev_or_Path n
10411 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10413 (* This is completely undocumented, but Java null becomes
10414 * a NULL parameter.
10416 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10418 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10419 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10420 | StringList n | DeviceList n ->
10421 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10422 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10423 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10424 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10426 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10428 pr " %s[%s_len] = NULL;\n" n n;
10432 pr " %s = j%s;\n" n n
10435 (* Make the call. *)
10436 pr " r = guestfs_%s " name;
10437 generate_c_call_args ~handle:"g" style;
10440 (* Release the parameters. *)
10444 | Device n | Dev_or_Path n
10448 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10450 pr " if (j%s)\n" n;
10451 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10453 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10454 | StringList n | DeviceList n ->
10455 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10456 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10458 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10460 pr " free (%s);\n" n
10466 (* Check for errors. *)
10467 pr " if (r == %s) {\n" error_code;
10468 pr " throw_exception (env, guestfs_last_error (g));\n";
10469 pr " return %s;\n" no_ret;
10472 (* Return value. *)
10473 (match fst style with
10475 | RInt _ -> pr " return (jint) r;\n"
10476 | RBool _ -> pr " return (jboolean) r;\n"
10477 | RInt64 _ -> pr " return (jlong) r;\n"
10478 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10479 | RConstOptString _ ->
10480 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10482 pr " jr = (*env)->NewStringUTF (env, r);\n";
10486 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10487 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10488 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10489 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10490 pr " for (i = 0; i < r_len; ++i) {\n";
10491 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10492 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10493 pr " free (r[i]);\n";
10497 | RStruct (_, typ) ->
10498 let jtyp = java_name_of_struct typ in
10499 let cols = cols_of_struct typ in
10500 generate_java_struct_return typ jtyp cols
10501 | RStructList (_, typ) ->
10502 let jtyp = java_name_of_struct typ in
10503 let cols = cols_of_struct typ in
10504 generate_java_struct_list_return typ jtyp cols
10507 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10508 pr " return NULL;\n"
10510 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10519 and generate_java_struct_return typ jtyp cols =
10520 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10521 pr " jr = (*env)->AllocObject (env, cl);\n";
10525 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10526 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10529 pr " char s[33];\n";
10530 pr " memcpy (s, r->%s, 32);\n" name;
10531 pr " s[32] = 0;\n";
10532 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10533 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10537 pr " int len = r->%s_len;\n" name;
10538 pr " char s[len+1];\n";
10539 pr " memcpy (s, r->%s, len);\n" name;
10540 pr " s[len] = 0;\n";
10541 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10542 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10544 | name, (FBytes|FUInt64|FInt64) ->
10545 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10546 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10547 | name, (FUInt32|FInt32) ->
10548 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10549 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10550 | name, FOptPercent ->
10551 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10552 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10554 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10555 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10560 and generate_java_struct_list_return typ jtyp cols =
10561 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10562 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10563 pr " for (i = 0; i < r->len; ++i) {\n";
10564 pr " jfl = (*env)->AllocObject (env, cl);\n";
10568 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10569 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10572 pr " char s[33];\n";
10573 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10574 pr " s[32] = 0;\n";
10575 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10576 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10580 pr " int len = r->val[i].%s_len;\n" name;
10581 pr " char s[len+1];\n";
10582 pr " memcpy (s, r->val[i].%s, len);\n" name;
10583 pr " s[len] = 0;\n";
10584 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10585 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10587 | name, (FBytes|FUInt64|FInt64) ->
10588 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10589 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10590 | name, (FUInt32|FInt32) ->
10591 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10592 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10593 | name, FOptPercent ->
10594 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10595 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10597 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10598 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10600 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10602 pr " guestfs_free_%s_list (r);\n" typ;
10605 and generate_java_makefile_inc () =
10606 generate_header HashStyle GPLv2plus;
10608 pr "java_built_sources = \\\n";
10611 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10613 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10615 and generate_haskell_hs () =
10616 generate_header HaskellStyle LGPLv2plus;
10618 (* XXX We only know how to generate partial FFI for Haskell
10619 * at the moment. Please help out!
10621 let can_generate style =
10625 | RInt64 _, _ -> true
10627 | RConstString _, _
10628 | RConstOptString _, _
10634 | RBufferOut _, _ -> false in
10637 {-# INCLUDE <guestfs.h> #-}
10638 {-# LANGUAGE ForeignFunctionInterface #-}
10643 (* List out the names of the actions we want to export. *)
10645 fun (name, style, _, _, _, _, _) ->
10646 if can_generate style then pr ",\n %s" name
10652 -- Unfortunately some symbols duplicate ones already present
10653 -- in Prelude. We don't know which, so we hard-code a list
10655 import Prelude hiding (truncate)
10659 import Foreign.C.Types
10661 import Control.Exception
10662 import Data.Typeable
10664 data GuestfsS = GuestfsS -- represents the opaque C struct
10665 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10666 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10668 -- XXX define properly later XXX
10672 data IntBool = IntBool
10674 data StatVFS = StatVFS
10675 data Hashtable = Hashtable
10677 foreign import ccall unsafe \"guestfs_create\" c_create
10679 foreign import ccall unsafe \"&guestfs_close\" c_close
10680 :: FunPtr (GuestfsP -> IO ())
10681 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10682 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10684 create :: IO GuestfsH
10687 c_set_error_handler p nullPtr nullPtr
10688 h <- newForeignPtr c_close p
10691 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10692 :: GuestfsP -> IO CString
10694 -- last_error :: GuestfsH -> IO (Maybe String)
10695 -- last_error h = do
10696 -- str <- withForeignPtr h (\\p -> c_last_error p)
10697 -- maybePeek peekCString str
10699 last_error :: GuestfsH -> IO (String)
10701 str <- withForeignPtr h (\\p -> c_last_error p)
10702 if (str == nullPtr)
10703 then return \"no error\"
10704 else peekCString str
10708 (* Generate wrappers for each foreign function. *)
10710 fun (name, style, _, _, _, _, _) ->
10711 if can_generate style then (
10712 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10714 generate_haskell_prototype ~handle:"GuestfsP" style;
10718 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10720 pr "%s %s = do\n" name
10721 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10723 (* Convert pointer arguments using with* functions. *)
10728 | Pathname n | Device n | Dev_or_Path n | String n ->
10729 pr "withCString %s $ \\%s -> " n n
10731 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10732 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10733 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10734 | Bool _ | Int _ | Int64 _ -> ()
10736 (* Convert integer arguments. *)
10740 | Bool n -> sprintf "(fromBool %s)" n
10741 | Int n -> sprintf "(fromIntegral %s)" n
10742 | Int64 n -> sprintf "(fromIntegral %s)" n
10743 | FileIn n | FileOut n
10744 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10745 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
10747 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10748 (String.concat " " ("p" :: args));
10749 (match fst style with
10750 | RErr | RInt _ | RInt64 _ | RBool _ ->
10751 pr " if (r == -1)\n";
10753 pr " err <- last_error h\n";
10755 | RConstString _ | RConstOptString _ | RString _
10756 | RStringList _ | RStruct _
10757 | RStructList _ | RHashtable _ | RBufferOut _ ->
10758 pr " if (r == nullPtr)\n";
10760 pr " err <- last_error h\n";
10763 (match fst style with
10765 pr " else return ()\n"
10767 pr " else return (fromIntegral r)\n"
10769 pr " else return (fromIntegral r)\n"
10771 pr " else return (toBool r)\n"
10773 | RConstOptString _
10780 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10786 and generate_haskell_prototype ~handle ?(hs = false) style =
10787 pr "%s -> " handle;
10788 let string = if hs then "String" else "CString" in
10789 let int = if hs then "Int" else "CInt" in
10790 let bool = if hs then "Bool" else "CInt" in
10791 let int64 = if hs then "Integer" else "Int64" in
10795 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10797 if hs then pr "String"
10798 else pr "CString -> CInt"
10799 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10800 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10801 | Bool _ -> pr "%s" bool
10802 | Int _ -> pr "%s" int
10803 | Int64 _ -> pr "%s" int
10804 | FileIn _ -> pr "%s" string
10805 | FileOut _ -> pr "%s" string
10810 (match fst style with
10811 | RErr -> if not hs then pr "CInt"
10812 | RInt _ -> pr "%s" int
10813 | RInt64 _ -> pr "%s" int64
10814 | RBool _ -> pr "%s" bool
10815 | RConstString _ -> pr "%s" string
10816 | RConstOptString _ -> pr "Maybe %s" string
10817 | RString _ -> pr "%s" string
10818 | RStringList _ -> pr "[%s]" string
10819 | RStruct (_, typ) ->
10820 let name = java_name_of_struct typ in
10822 | RStructList (_, typ) ->
10823 let name = java_name_of_struct typ in
10825 | RHashtable _ -> pr "Hashtable"
10826 | RBufferOut _ -> pr "%s" string
10830 and generate_csharp () =
10831 generate_header CPlusPlusStyle LGPLv2plus;
10833 (* XXX Make this configurable by the C# assembly users. *)
10834 let library = "libguestfs.so.0" in
10837 // These C# bindings are highly experimental at present.
10839 // Firstly they only work on Linux (ie. Mono). In order to get them
10840 // to work on Windows (ie. .Net) you would need to port the library
10841 // itself to Windows first.
10843 // The second issue is that some calls are known to be incorrect and
10844 // can cause Mono to segfault. Particularly: calls which pass or
10845 // return string[], or return any structure value. This is because
10846 // we haven't worked out the correct way to do this from C#.
10848 // The third issue is that when compiling you get a lot of warnings.
10849 // We are not sure whether the warnings are important or not.
10851 // Fourthly we do not routinely build or test these bindings as part
10852 // of the make && make check cycle, which means that regressions might
10855 // Suggestions and patches are welcome.
10859 // gmcs Libguestfs.cs
10860 // mono Libguestfs.exe
10862 // (You'll probably want to add a Test class / static main function
10863 // otherwise this won't do anything useful).
10867 using System.Runtime.InteropServices;
10868 using System.Runtime.Serialization;
10869 using System.Collections;
10873 class Error : System.ApplicationException
10875 public Error (string message) : base (message) {}
10876 protected Error (SerializationInfo info, StreamingContext context) {}
10883 [DllImport (\"%s\")]
10884 static extern IntPtr guestfs_create ();
10888 _handle = guestfs_create ();
10889 if (_handle == IntPtr.Zero)
10890 throw new Error (\"could not create guestfs handle\");
10893 [DllImport (\"%s\")]
10894 static extern void guestfs_close (IntPtr h);
10898 guestfs_close (_handle);
10901 [DllImport (\"%s\")]
10902 static extern string guestfs_last_error (IntPtr h);
10904 " library library library;
10906 (* Generate C# structure bindings. We prefix struct names with
10907 * underscore because C# cannot have conflicting struct names and
10908 * method names (eg. "class stat" and "stat").
10912 pr " [StructLayout (LayoutKind.Sequential)]\n";
10913 pr " public class _%s {\n" typ;
10916 | name, FChar -> pr " char %s;\n" name
10917 | name, FString -> pr " string %s;\n" name
10919 pr " uint %s_len;\n" name;
10920 pr " string %s;\n" name
10922 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10923 pr " string %s;\n" name
10924 | name, FUInt32 -> pr " uint %s;\n" name
10925 | name, FInt32 -> pr " int %s;\n" name
10926 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10927 | name, FInt64 -> pr " long %s;\n" name
10928 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10934 (* Generate C# function bindings. *)
10936 fun (name, style, _, _, _, shortdesc, _) ->
10937 let rec csharp_return_type () =
10938 match fst style with
10940 | RBool n -> "bool"
10942 | RInt64 n -> "long"
10944 | RConstOptString n
10946 | RBufferOut n -> "string"
10947 | RStruct (_,n) -> "_" ^ n
10948 | RHashtable n -> "Hashtable"
10949 | RStringList n -> "string[]"
10950 | RStructList (_,n) -> sprintf "_%s[]" n
10952 and c_return_type () =
10953 match fst style with
10957 | RInt64 _ -> "long"
10959 | RConstOptString _
10961 | RBufferOut _ -> "string"
10962 | RStruct (_,n) -> "_" ^ n
10964 | RStringList _ -> "string[]"
10965 | RStructList (_,n) -> sprintf "_%s[]" n
10967 and c_error_comparison () =
10968 match fst style with
10972 | RInt64 _ -> "== -1"
10974 | RConstOptString _
10980 | RStructList (_,_) -> "== null"
10982 and generate_extern_prototype () =
10983 pr " static extern %s guestfs_%s (IntPtr h"
10984 (c_return_type ()) name;
10987 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10988 | FileIn n | FileOut n
10990 pr ", [In] string %s" n
10991 | StringList n | DeviceList n ->
10992 pr ", [In] string[] %s" n
11002 and generate_public_prototype () =
11003 pr " public %s %s (" (csharp_return_type ()) name;
11004 let comma = ref false in
11006 if !comma then pr ", ";
11011 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11012 | FileIn n | FileOut n
11014 next (); pr "string %s" n
11015 | StringList n | DeviceList n ->
11016 next (); pr "string[] %s" n
11018 next (); pr "bool %s" n
11020 next (); pr "int %s" n
11022 next (); pr "long %s" n
11026 and generate_call () =
11027 pr "guestfs_%s (_handle" name;
11028 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
11032 pr " [DllImport (\"%s\")]\n" library;
11033 generate_extern_prototype ();
11035 pr " /// <summary>\n";
11036 pr " /// %s\n" shortdesc;
11037 pr " /// </summary>\n";
11038 generate_public_prototype ();
11040 pr " %s r;\n" (c_return_type ());
11043 pr " if (r %s)\n" (c_error_comparison ());
11044 pr " throw new Error (guestfs_last_error (_handle));\n";
11045 (match fst style with
11048 pr " return r != 0 ? true : false;\n"
11050 pr " Hashtable rr = new Hashtable ();\n";
11051 pr " for (int i = 0; i < r.Length; i += 2)\n";
11052 pr " rr.Add (r[i], r[i+1]);\n";
11054 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
11055 | RString _ | RBufferOut _ | RStruct _ | RStringList _
11061 ) all_functions_sorted;
11067 and generate_bindtests () =
11068 generate_header CStyle LGPLv2plus;
11072 #include <stdlib.h>
11073 #include <inttypes.h>
11074 #include <string.h>
11076 #include \"guestfs.h\"
11077 #include \"guestfs-internal.h\"
11078 #include \"guestfs-internal-actions.h\"
11079 #include \"guestfs_protocol.h\"
11081 #define error guestfs_error
11082 #define safe_calloc guestfs_safe_calloc
11083 #define safe_malloc guestfs_safe_malloc
11086 print_strings (char *const *argv)
11091 for (argc = 0; argv[argc] != NULL; ++argc) {
11092 if (argc > 0) printf (\", \");
11093 printf (\"\\\"%%s\\\"\", argv[argc]);
11098 /* The test0 function prints its parameters to stdout. */
11102 match test_functions with
11103 | [] -> assert false
11104 | test0 :: tests -> test0, tests in
11107 let (name, style, _, _, _, _, _) = test0 in
11108 generate_prototype ~extern:false ~semicolon:false ~newline:true
11109 ~handle:"g" ~prefix:"guestfs__" name style;
11114 | Device n | Dev_or_Path n
11117 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
11121 pr " for (i = 0; i < %s_size; ++i)\n" n;
11122 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11123 pr " printf (\"\\n\");\n";
11125 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11126 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11127 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11128 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11129 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11131 pr " /* Java changes stdout line buffering so we need this: */\n";
11132 pr " fflush (stdout);\n";
11138 fun (name, style, _, _, _, _, _) ->
11139 if String.sub name (String.length name - 3) 3 <> "err" then (
11140 pr "/* Test normal return. */\n";
11141 generate_prototype ~extern:false ~semicolon:false ~newline:true
11142 ~handle:"g" ~prefix:"guestfs__" name style;
11144 (match fst style with
11149 pr " sscanf (val, \"%%d\", &r);\n";
11152 pr " int64_t r;\n";
11153 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11156 pr " return STREQ (val, \"true\");\n"
11158 | RConstOptString _ ->
11159 (* Can't return the input string here. Return a static
11160 * string so we ensure we get a segfault if the caller
11161 * tries to free it.
11163 pr " return \"static string\";\n"
11165 pr " return strdup (val);\n"
11167 pr " char **strs;\n";
11169 pr " sscanf (val, \"%%d\", &n);\n";
11170 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11171 pr " for (i = 0; i < n; ++i) {\n";
11172 pr " strs[i] = safe_malloc (g, 16);\n";
11173 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11175 pr " strs[n] = NULL;\n";
11176 pr " return strs;\n"
11177 | RStruct (_, typ) ->
11178 pr " struct guestfs_%s *r;\n" typ;
11179 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11181 | RStructList (_, typ) ->
11182 pr " struct guestfs_%s_list *r;\n" typ;
11183 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11184 pr " sscanf (val, \"%%d\", &r->len);\n";
11185 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11188 pr " char **strs;\n";
11190 pr " sscanf (val, \"%%d\", &n);\n";
11191 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11192 pr " for (i = 0; i < n; ++i) {\n";
11193 pr " strs[i*2] = safe_malloc (g, 16);\n";
11194 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11195 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11196 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11198 pr " strs[n*2] = NULL;\n";
11199 pr " return strs;\n"
11201 pr " return strdup (val);\n"
11206 pr "/* Test error return. */\n";
11207 generate_prototype ~extern:false ~semicolon:false ~newline:true
11208 ~handle:"g" ~prefix:"guestfs__" name style;
11210 pr " error (g, \"error\");\n";
11211 (match fst style with
11212 | RErr | RInt _ | RInt64 _ | RBool _ ->
11214 | RConstString _ | RConstOptString _
11215 | RString _ | RStringList _ | RStruct _
11219 pr " return NULL;\n"
11226 and generate_ocaml_bindtests () =
11227 generate_header OCamlStyle GPLv2plus;
11231 let g = Guestfs.create () in
11235 String.concat " " (
11238 | CallString s -> "\"" ^ s ^ "\""
11239 | CallOptString None -> "None"
11240 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11241 | CallStringList xs ->
11242 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11243 | CallInt i when i >= 0 -> string_of_int i
11244 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11245 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11246 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11247 | CallBool b -> string_of_bool b
11248 | CallBuffer s -> sprintf "%S" s
11253 generate_lang_bindtests (
11254 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11257 pr "print_endline \"EOF\"\n"
11259 and generate_perl_bindtests () =
11260 pr "#!/usr/bin/perl -w\n";
11261 generate_header HashStyle GPLv2plus;
11268 my $g = Sys::Guestfs->new ();
11272 String.concat ", " (
11275 | CallString s -> "\"" ^ s ^ "\""
11276 | CallOptString None -> "undef"
11277 | CallOptString (Some s) -> sprintf "\"%s\"" s
11278 | CallStringList xs ->
11279 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11280 | CallInt i -> string_of_int i
11281 | CallInt64 i -> Int64.to_string i
11282 | CallBool b -> if b then "1" else "0"
11283 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11288 generate_lang_bindtests (
11289 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11292 pr "print \"EOF\\n\"\n"
11294 and generate_python_bindtests () =
11295 generate_header HashStyle GPLv2plus;
11300 g = guestfs.GuestFS ()
11304 String.concat ", " (
11307 | CallString s -> "\"" ^ s ^ "\""
11308 | CallOptString None -> "None"
11309 | CallOptString (Some s) -> sprintf "\"%s\"" s
11310 | CallStringList xs ->
11311 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11312 | CallInt i -> string_of_int i
11313 | CallInt64 i -> Int64.to_string i
11314 | CallBool b -> if b then "1" else "0"
11315 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11320 generate_lang_bindtests (
11321 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11324 pr "print \"EOF\"\n"
11326 and generate_ruby_bindtests () =
11327 generate_header HashStyle GPLv2plus;
11332 g = Guestfs::create()
11336 String.concat ", " (
11339 | CallString s -> "\"" ^ s ^ "\""
11340 | CallOptString None -> "nil"
11341 | CallOptString (Some s) -> sprintf "\"%s\"" s
11342 | CallStringList xs ->
11343 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11344 | CallInt i -> string_of_int i
11345 | CallInt64 i -> Int64.to_string i
11346 | CallBool b -> string_of_bool b
11347 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11352 generate_lang_bindtests (
11353 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11356 pr "print \"EOF\\n\"\n"
11358 and generate_java_bindtests () =
11359 generate_header CStyle GPLv2plus;
11362 import com.redhat.et.libguestfs.*;
11364 public class Bindtests {
11365 public static void main (String[] argv)
11368 GuestFS g = new GuestFS ();
11372 String.concat ", " (
11375 | CallString s -> "\"" ^ s ^ "\""
11376 | CallOptString None -> "null"
11377 | CallOptString (Some s) -> sprintf "\"%s\"" s
11378 | CallStringList xs ->
11380 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11381 | CallInt i -> string_of_int i
11382 | CallInt64 i -> Int64.to_string i
11383 | CallBool b -> string_of_bool b
11385 "new byte[] { " ^ String.concat "," (
11386 map_chars (fun c -> string_of_int (Char.code c)) s
11392 generate_lang_bindtests (
11393 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11397 System.out.println (\"EOF\");
11399 catch (Exception exn) {
11400 System.err.println (exn);
11407 and generate_haskell_bindtests () =
11408 generate_header HaskellStyle GPLv2plus;
11411 module Bindtests where
11412 import qualified Guestfs
11415 g <- Guestfs.create
11419 String.concat " " (
11422 | CallString s -> "\"" ^ s ^ "\""
11423 | CallOptString None -> "Nothing"
11424 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11425 | CallStringList xs ->
11426 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11427 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11428 | CallInt i -> string_of_int i
11429 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11430 | CallInt64 i -> Int64.to_string i
11431 | CallBool true -> "True"
11432 | CallBool false -> "False"
11433 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11438 generate_lang_bindtests (
11439 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11442 pr " putStrLn \"EOF\"\n"
11444 (* Language-independent bindings tests - we do it this way to
11445 * ensure there is parity in testing bindings across all languages.
11447 and generate_lang_bindtests call =
11448 call "test0" [CallString "abc"; CallOptString (Some "def");
11449 CallStringList []; CallBool false;
11450 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11451 CallBuffer "abc\000abc"];
11452 call "test0" [CallString "abc"; CallOptString None;
11453 CallStringList []; CallBool false;
11454 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11455 CallBuffer "abc\000abc"];
11456 call "test0" [CallString ""; CallOptString (Some "def");
11457 CallStringList []; CallBool false;
11458 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11459 CallBuffer "abc\000abc"];
11460 call "test0" [CallString ""; CallOptString (Some "");
11461 CallStringList []; CallBool false;
11462 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11463 CallBuffer "abc\000abc"];
11464 call "test0" [CallString "abc"; CallOptString (Some "def");
11465 CallStringList ["1"]; CallBool false;
11466 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11467 CallBuffer "abc\000abc"];
11468 call "test0" [CallString "abc"; CallOptString (Some "def");
11469 CallStringList ["1"; "2"]; CallBool false;
11470 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11471 CallBuffer "abc\000abc"];
11472 call "test0" [CallString "abc"; CallOptString (Some "def");
11473 CallStringList ["1"]; CallBool true;
11474 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11475 CallBuffer "abc\000abc"];
11476 call "test0" [CallString "abc"; CallOptString (Some "def");
11477 CallStringList ["1"]; CallBool false;
11478 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11479 CallBuffer "abc\000abc"];
11480 call "test0" [CallString "abc"; CallOptString (Some "def");
11481 CallStringList ["1"]; CallBool false;
11482 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11483 CallBuffer "abc\000abc"];
11484 call "test0" [CallString "abc"; CallOptString (Some "def");
11485 CallStringList ["1"]; CallBool false;
11486 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11487 CallBuffer "abc\000abc"];
11488 call "test0" [CallString "abc"; CallOptString (Some "def");
11489 CallStringList ["1"]; CallBool false;
11490 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11491 CallBuffer "abc\000abc"];
11492 call "test0" [CallString "abc"; CallOptString (Some "def");
11493 CallStringList ["1"]; CallBool false;
11494 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11495 CallBuffer "abc\000abc"];
11496 call "test0" [CallString "abc"; CallOptString (Some "def");
11497 CallStringList ["1"]; CallBool false;
11498 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11499 CallBuffer "abc\000abc"]
11501 (* XXX Add here tests of the return and error functions. *)
11503 (* Code to generator bindings for virt-inspector. Currently only
11504 * implemented for OCaml code (for virt-p2v 2.0).
11506 let rng_input = "inspector/virt-inspector.rng"
11508 (* Read the input file and parse it into internal structures. This is
11509 * by no means a complete RELAX NG parser, but is just enough to be
11510 * able to parse the specific input file.
11513 | Element of string * rng list (* <element name=name/> *)
11514 | Attribute of string * rng list (* <attribute name=name/> *)
11515 | Interleave of rng list (* <interleave/> *)
11516 | ZeroOrMore of rng (* <zeroOrMore/> *)
11517 | OneOrMore of rng (* <oneOrMore/> *)
11518 | Optional of rng (* <optional/> *)
11519 | Choice of string list (* <choice><value/>*</choice> *)
11520 | Value of string (* <value>str</value> *)
11521 | Text (* <text/> *)
11523 let rec string_of_rng = function
11524 | Element (name, xs) ->
11525 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11526 | Attribute (name, xs) ->
11527 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11528 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11529 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11530 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11531 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11532 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11533 | Value value -> "Value \"" ^ value ^ "\""
11536 and string_of_rng_list xs =
11537 String.concat ", " (List.map string_of_rng xs)
11539 let rec parse_rng ?defines context = function
11541 | Xml.Element ("element", ["name", name], children) :: rest ->
11542 Element (name, parse_rng ?defines context children)
11543 :: parse_rng ?defines context rest
11544 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11545 Attribute (name, parse_rng ?defines context children)
11546 :: parse_rng ?defines context rest
11547 | Xml.Element ("interleave", [], children) :: rest ->
11548 Interleave (parse_rng ?defines context children)
11549 :: parse_rng ?defines context rest
11550 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11551 let rng = parse_rng ?defines context [child] in
11553 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11555 failwithf "%s: <zeroOrMore> contains more than one child element"
11558 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11559 let rng = parse_rng ?defines context [child] in
11561 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11563 failwithf "%s: <oneOrMore> contains more than one child element"
11566 | Xml.Element ("optional", [], [child]) :: rest ->
11567 let rng = parse_rng ?defines context [child] in
11569 | [child] -> Optional child :: parse_rng ?defines context rest
11571 failwithf "%s: <optional> contains more than one child element"
11574 | Xml.Element ("choice", [], children) :: rest ->
11575 let values = List.map (
11576 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11578 failwithf "%s: can't handle anything except <value> in <choice>"
11582 :: parse_rng ?defines context rest
11583 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11584 Value value :: parse_rng ?defines context rest
11585 | Xml.Element ("text", [], []) :: rest ->
11586 Text :: parse_rng ?defines context rest
11587 | Xml.Element ("ref", ["name", name], []) :: rest ->
11588 (* Look up the reference. Because of limitations in this parser,
11589 * we can't handle arbitrarily nested <ref> yet. You can only
11590 * use <ref> from inside <start>.
11592 (match defines with
11594 failwithf "%s: contains <ref>, but no refs are defined yet" context
11596 let rng = StringMap.find name map in
11597 rng @ parse_rng ?defines context rest
11600 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11603 let xml = Xml.parse_file rng_input in
11605 | Xml.Element ("grammar", _,
11606 Xml.Element ("start", _, gram) :: defines) ->
11607 (* The <define/> elements are referenced in the <start> section,
11608 * so build a map of those first.
11610 let defines = List.fold_left (
11612 function Xml.Element ("define", ["name", name], defn) ->
11613 StringMap.add name defn map
11615 failwithf "%s: expected <define name=name/>" rng_input
11616 ) StringMap.empty defines in
11617 let defines = StringMap.mapi parse_rng defines in
11619 (* Parse the <start> clause, passing the defines. *)
11620 parse_rng ~defines "<start>" gram
11622 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11625 let name_of_field = function
11626 | Element (name, _) | Attribute (name, _)
11627 | ZeroOrMore (Element (name, _))
11628 | OneOrMore (Element (name, _))
11629 | Optional (Element (name, _)) -> name
11630 | Optional (Attribute (name, _)) -> name
11631 | Text -> (* an unnamed field in an element *)
11634 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11636 (* At the moment this function only generates OCaml types. However we
11637 * should parameterize it later so it can generate types/structs in a
11638 * variety of languages.
11640 let generate_types xs =
11641 (* A simple type is one that can be printed out directly, eg.
11642 * "string option". A complex type is one which has a name and has
11643 * to be defined via another toplevel definition, eg. a struct.
11645 * generate_type generates code for either simple or complex types.
11646 * In the simple case, it returns the string ("string option"). In
11647 * the complex case, it returns the name ("mountpoint"). In the
11648 * complex case it has to print out the definition before returning,
11649 * so it should only be called when we are at the beginning of a
11650 * new line (BOL context).
11652 let rec generate_type = function
11653 | Text -> (* string *)
11655 | Choice values -> (* [`val1|`val2|...] *)
11656 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11657 | ZeroOrMore rng -> (* <rng> list *)
11658 let t, is_simple = generate_type rng in
11659 t ^ " list (* 0 or more *)", is_simple
11660 | OneOrMore rng -> (* <rng> list *)
11661 let t, is_simple = generate_type rng in
11662 t ^ " list (* 1 or more *)", is_simple
11663 (* virt-inspector hack: bool *)
11664 | Optional (Attribute (name, [Value "1"])) ->
11666 | Optional rng -> (* <rng> list *)
11667 let t, is_simple = generate_type rng in
11668 t ^ " option", is_simple
11669 (* type name = { fields ... } *)
11670 | Element (name, fields) when is_attrs_interleave fields ->
11671 generate_type_struct name (get_attrs_interleave fields)
11672 | Element (name, [field]) (* type name = field *)
11673 | Attribute (name, [field]) ->
11674 let t, is_simple = generate_type field in
11675 if is_simple then (t, true)
11677 pr "type %s = %s\n" name t;
11680 | Element (name, fields) -> (* type name = { fields ... } *)
11681 generate_type_struct name fields
11683 failwithf "generate_type failed at: %s" (string_of_rng rng)
11685 and is_attrs_interleave = function
11686 | [Interleave _] -> true
11687 | Attribute _ :: fields -> is_attrs_interleave fields
11688 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11691 and get_attrs_interleave = function
11692 | [Interleave fields] -> fields
11693 | ((Attribute _) as field) :: fields
11694 | ((Optional (Attribute _)) as field) :: fields ->
11695 field :: get_attrs_interleave fields
11696 | _ -> assert false
11698 and generate_types xs =
11699 List.iter (fun x -> ignore (generate_type x)) xs
11701 and generate_type_struct name fields =
11702 (* Calculate the types of the fields first. We have to do this
11703 * before printing anything so we are still in BOL context.
11705 let types = List.map fst (List.map generate_type fields) in
11707 (* Special case of a struct containing just a string and another
11708 * field. Turn it into an assoc list.
11711 | ["string"; other] ->
11712 let fname1, fname2 =
11714 | [f1; f2] -> name_of_field f1, name_of_field f2
11715 | _ -> assert false in
11716 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11720 pr "type %s = {\n" name;
11722 fun (field, ftype) ->
11723 let fname = name_of_field field in
11724 pr " %s_%s : %s;\n" name fname ftype
11725 ) (List.combine fields types);
11727 (* Return the name of this type, and
11728 * false because it's not a simple type.
11735 let generate_parsers xs =
11736 (* As for generate_type above, generate_parser makes a parser for
11737 * some type, and returns the name of the parser it has generated.
11738 * Because it (may) need to print something, it should always be
11739 * called in BOL context.
11741 let rec generate_parser = function
11742 | Text -> (* string *)
11743 "string_child_or_empty"
11744 | Choice values -> (* [`val1|`val2|...] *)
11745 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11747 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11748 | ZeroOrMore rng -> (* <rng> list *)
11749 let pa = generate_parser rng in
11750 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11751 | OneOrMore rng -> (* <rng> list *)
11752 let pa = generate_parser rng in
11753 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11754 (* virt-inspector hack: bool *)
11755 | Optional (Attribute (name, [Value "1"])) ->
11756 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11757 | Optional rng -> (* <rng> list *)
11758 let pa = generate_parser rng in
11759 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11760 (* type name = { fields ... } *)
11761 | Element (name, fields) when is_attrs_interleave fields ->
11762 generate_parser_struct name (get_attrs_interleave fields)
11763 | Element (name, [field]) -> (* type name = field *)
11764 let pa = generate_parser field in
11765 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11766 pr "let %s =\n" parser_name;
11768 pr "let parse_%s = %s\n" name parser_name;
11770 | Attribute (name, [field]) ->
11771 let pa = generate_parser field in
11772 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11773 pr "let %s =\n" parser_name;
11775 pr "let parse_%s = %s\n" name parser_name;
11777 | Element (name, fields) -> (* type name = { fields ... } *)
11778 generate_parser_struct name ([], fields)
11780 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11782 and is_attrs_interleave = function
11783 | [Interleave _] -> true
11784 | Attribute _ :: fields -> is_attrs_interleave fields
11785 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11788 and get_attrs_interleave = function
11789 | [Interleave fields] -> [], fields
11790 | ((Attribute _) as field) :: fields
11791 | ((Optional (Attribute _)) as field) :: fields ->
11792 let attrs, interleaves = get_attrs_interleave fields in
11793 (field :: attrs), interleaves
11794 | _ -> assert false
11796 and generate_parsers xs =
11797 List.iter (fun x -> ignore (generate_parser x)) xs
11799 and generate_parser_struct name (attrs, interleaves) =
11800 (* Generate parsers for the fields first. We have to do this
11801 * before printing anything so we are still in BOL context.
11803 let fields = attrs @ interleaves in
11804 let pas = List.map generate_parser fields in
11806 (* Generate an intermediate tuple from all the fields first.
11807 * If the type is just a string + another field, then we will
11808 * return this directly, otherwise it is turned into a record.
11810 * RELAX NG note: This code treats <interleave> and plain lists of
11811 * fields the same. In other words, it doesn't bother enforcing
11812 * any ordering of fields in the XML.
11814 pr "let parse_%s x =\n" name;
11815 pr " let t = (\n ";
11816 let comma = ref false in
11819 if !comma then pr ",\n ";
11822 | Optional (Attribute (fname, [field])), pa ->
11824 | Optional (Element (fname, [field])), pa ->
11825 pr "%s (optional_child %S x)" pa fname
11826 | Attribute (fname, [Text]), _ ->
11827 pr "attribute %S x" fname
11828 | (ZeroOrMore _ | OneOrMore _), pa ->
11833 let fname = name_of_field field in
11834 pr "%s (child %S x)" pa fname
11835 ) (List.combine fields pas);
11839 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11843 pr " (Obj.magic t : %s)\n" name
11847 | (Optional (Attribute (fname, [field])), pa) ->
11848 pr " %s_%s =\n" name fname;
11850 | (Optional (Element (fname, [field])), pa) ->
11851 pr " %s_%s =\n" name fname;
11852 pr " (let x = optional_child %S x in\n" fname;
11855 let fname = name_of_field field in
11856 pr " %s_%s =\n" name fname;
11857 pr " (let x = child %S x in\n" fname;
11859 ) (List.combine fields pas);
11863 sprintf "parse_%s" name
11866 generate_parsers xs
11868 (* Generate ocaml/guestfs_inspector.mli. *)
11869 let generate_ocaml_inspector_mli () =
11870 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11873 (** This is an OCaml language binding to the external [virt-inspector]
11876 For more information, please read the man page [virt-inspector(1)].
11881 generate_types grammar;
11882 pr "(** The nested information returned from the {!inspect} function. *)\n";
11886 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11887 (** To inspect a libvirt domain called [name], pass a singleton
11888 list: [inspect [name]]. When using libvirt only, you may
11889 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11891 To inspect a disk image or images, pass a list of the filenames
11892 of the disk images: [inspect filenames]
11894 This function inspects the given guest or disk images and
11895 returns a list of operating system(s) found and a large amount
11896 of information about them. In the vast majority of cases,
11897 a virtual machine only contains a single operating system.
11899 If the optional [~xml] parameter is given, then this function
11900 skips running the external virt-inspector program and just
11901 parses the given XML directly (which is expected to be XML
11902 produced from a previous run of virt-inspector). The list of
11903 names and connect URI are ignored in this case.
11905 This function can throw a wide variety of exceptions, for example
11906 if the external virt-inspector program cannot be found, or if
11907 it doesn't generate valid XML.
11911 (* Generate ocaml/guestfs_inspector.ml. *)
11912 let generate_ocaml_inspector_ml () =
11913 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11918 generate_types grammar;
11922 (* Misc functions which are used by the parser code below. *)
11923 let first_child = function
11924 | Xml.Element (_, _, c::_) -> c
11925 | Xml.Element (name, _, []) ->
11926 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11927 | Xml.PCData str ->
11928 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11930 let string_child_or_empty = function
11931 | Xml.Element (_, _, [Xml.PCData s]) -> s
11932 | Xml.Element (_, _, []) -> \"\"
11933 | Xml.Element (x, _, _) ->
11934 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11936 | Xml.PCData str ->
11937 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11939 let optional_child name xml =
11940 let children = Xml.children xml in
11942 Some (List.find (function
11943 | Xml.Element (n, _, _) when n = name -> true
11944 | _ -> false) children)
11948 let child name xml =
11949 match optional_child name xml with
11952 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11954 let attribute name xml =
11955 try Xml.attrib xml name
11956 with Xml.No_attribute _ ->
11957 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11961 generate_parsers grammar;
11965 (* Run external virt-inspector, then use parser to parse the XML. *)
11966 let inspect ?connect ?xml names =
11970 if names = [] then invalid_arg \"inspect: no names given\";
11971 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11972 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11974 let cmd = List.map Filename.quote cmd in
11975 let cmd = String.concat \" \" cmd in
11976 let chan = open_process_in cmd in
11977 let xml = Xml.parse_in chan in
11978 (match close_process_in chan with
11980 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11981 | WSIGNALED i | WSTOPPED i ->
11982 failwith (\"external virt-inspector command died or stopped on sig \" ^
11987 Xml.parse_string doc in
11988 parse_operatingsystems xml
11991 and generate_max_proc_nr () =
11992 pr "%d\n" max_proc_nr
11994 let output_to filename k =
11995 let filename_new = filename ^ ".new" in
11996 chan := open_out filename_new;
11999 chan := Pervasives.stdout;
12001 (* Is the new file different from the current file? *)
12002 if Sys.file_exists filename && files_equal filename filename_new then
12003 unlink filename_new (* same, so skip it *)
12005 (* different, overwrite old one *)
12006 (try chmod filename 0o644 with Unix_error _ -> ());
12007 rename filename_new filename;
12008 chmod filename 0o444;
12009 printf "written %s\n%!" filename;
12012 let perror msg = function
12013 | Unix_error (err, _, _) ->
12014 eprintf "%s: %s\n" msg (error_message err)
12016 eprintf "%s: %s\n" msg (Printexc.to_string exn)
12018 (* Main program. *)
12021 try openfile "HACKING" [O_RDWR] 0
12023 | Unix_error (ENOENT, _, _) ->
12025 You are probably running this from the wrong directory.
12026 Run it from the top source directory using the command
12031 perror "open: HACKING" exn;
12034 (* Acquire a lock so parallel builds won't try to run the generator
12035 * twice at the same time. Subsequent builds will wait for the first
12036 * one to finish. Note the lock is released implicitly when the
12039 (try lockf lock_fd F_LOCK 1
12041 perror "lock: HACKING" exn;
12044 check_functions ();
12046 output_to "src/guestfs_protocol.x" generate_xdr;
12047 output_to "src/guestfs-structs.h" generate_structs_h;
12048 output_to "src/guestfs-actions.h" generate_actions_h;
12049 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
12050 output_to "src/guestfs-actions.c" generate_client_actions;
12051 output_to "src/guestfs-bindtests.c" generate_bindtests;
12052 output_to "src/guestfs-structs.pod" generate_structs_pod;
12053 output_to "src/guestfs-actions.pod" generate_actions_pod;
12054 output_to "src/guestfs-availability.pod" generate_availability_pod;
12055 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
12056 output_to "src/libguestfs.syms" generate_linker_script;
12057 output_to "daemon/actions.h" generate_daemon_actions_h;
12058 output_to "daemon/stubs.c" generate_daemon_actions;
12059 output_to "daemon/names.c" generate_daemon_names;
12060 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
12061 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
12062 output_to "capitests/tests.c" generate_tests;
12063 output_to "fish/cmds.c" generate_fish_cmds;
12064 output_to "fish/completion.c" generate_fish_completion;
12065 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
12066 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
12067 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
12068 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
12069 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
12070 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
12071 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
12072 output_to "perl/Guestfs.xs" generate_perl_xs;
12073 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
12074 output_to "perl/bindtests.pl" generate_perl_bindtests;
12075 output_to "python/guestfs-py.c" generate_python_c;
12076 output_to "python/guestfs.py" generate_python_py;
12077 output_to "python/bindtests.py" generate_python_bindtests;
12078 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12079 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12080 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12084 let cols = cols_of_struct typ in
12085 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12086 output_to filename (generate_java_struct jtyp cols);
12089 output_to "java/Makefile.inc" generate_java_makefile_inc;
12090 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12091 output_to "java/Bindtests.java" generate_java_bindtests;
12092 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12093 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12094 output_to "csharp/Libguestfs.cs" generate_csharp;
12096 (* Always generate this file last, and unconditionally. It's used
12097 * by the Makefile to know when we must re-run the generator.
12099 let chan = open_out "src/stamp-generator" in
12100 fprintf chan "1\n";
12103 printf "generated %d lines of code\n" !lines