3 * Copyright (C) 2009-2010 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <const char *, size_t> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
177 (* Key material / passphrase. Eventually we should treat this
178 * as sensitive and mlock it into physical RAM. However this
179 * is highly complex because of all the places that XDR-encoded
180 * strings can end up. So currently the only difference from
181 * 'String' is the way that guestfish requests these parameters
187 | ProtocolLimitWarning (* display warning about protocol size limits *)
188 | DangerWillRobinson (* flags particularly dangerous commands *)
189 | FishAlias of string (* provide an alias for this cmd in guestfish *)
190 | FishOutput of fish_output_t (* how to display output in guestfish *)
191 | NotInFish (* do not export via guestfish *)
192 | NotInDocs (* do not add this function to documentation *)
193 | DeprecatedBy of string (* function is deprecated, use .. instead *)
194 | Optional of string (* function is part of an optional group *)
197 | FishOutputOctal (* for int return, print in octal *)
198 | FishOutputHexadecimal (* for int return, print in hex *)
200 (* You can supply zero or as many tests as you want per API call.
202 * Note that the test environment has 3 block devices, of size 500MB,
203 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
204 * a fourth ISO block device with some known files on it (/dev/sdd).
206 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
207 * Number of cylinders was 63 for IDE emulated disks with precisely
208 * the same size. How exactly this is calculated is a mystery.
210 * The ISO block device (/dev/sdd) comes from images/test.iso.
212 * To be able to run the tests in a reasonable amount of time,
213 * the virtual machine and block devices are reused between tests.
214 * So don't try testing kill_subprocess :-x
216 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
218 * Don't assume anything about the previous contents of the block
219 * devices. Use 'Init*' to create some initial scenarios.
221 * You can add a prerequisite clause to any individual test. This
222 * is a run-time check, which, if it fails, causes the test to be
223 * skipped. Useful if testing a command which might not work on
224 * all variations of libguestfs builds. A test that has prerequisite
225 * of 'Always' is run unconditionally.
227 * In addition, packagers can skip individual tests by setting the
228 * environment variables: eg:
229 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
230 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
232 type tests = (test_init * test_prereq * test) list
234 (* Run the command sequence and just expect nothing to fail. *)
237 (* Run the command sequence and expect the output of the final
238 * command to be the string.
240 | TestOutput of seq * string
242 (* Run the command sequence and expect the output of the final
243 * command to be the list of strings.
245 | TestOutputList of seq * string list
247 (* Run the command sequence and expect the output of the final
248 * command to be the list of block devices (could be either
249 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
250 * character of each string).
252 | TestOutputListOfDevices of seq * string list
254 (* Run the command sequence and expect the output of the final
255 * command to be the integer.
257 | TestOutputInt of seq * int
259 (* Run the command sequence and expect the output of the final
260 * command to be <op> <int>, eg. ">=", "1".
262 | TestOutputIntOp of seq * string * int
264 (* Run the command sequence and expect the output of the final
265 * command to be a true value (!= 0 or != NULL).
267 | TestOutputTrue of seq
269 (* Run the command sequence and expect the output of the final
270 * command to be a false value (== 0 or == NULL, but not an error).
272 | TestOutputFalse of seq
274 (* Run the command sequence and expect the output of the final
275 * command to be a list of the given length (but don't care about
278 | TestOutputLength of seq * int
280 (* Run the command sequence and expect the output of the final
281 * command to be a buffer (RBufferOut), ie. string + size.
283 | TestOutputBuffer of seq * string
285 (* Run the command sequence and expect the output of the final
286 * command to be a structure.
288 | TestOutputStruct of seq * test_field_compare list
290 (* Run the command sequence and expect the final command (only)
293 | TestLastFail of seq
295 and test_field_compare =
296 | CompareWithInt of string * int
297 | CompareWithIntOp of string * string * int
298 | CompareWithString of string * string
299 | CompareFieldsIntEq of string * string
300 | CompareFieldsStrEq of string * string
302 (* Test prerequisites. *)
304 (* Test always runs. *)
307 (* Test is currently disabled - eg. it fails, or it tests some
308 * unimplemented feature.
312 (* 'string' is some C code (a function body) that should return
313 * true or false. The test will run if the code returns true.
317 (* As for 'If' but the test runs _unless_ the code returns true. *)
320 (* Run the test only if 'string' is available in the daemon. *)
321 | IfAvailable of string
323 (* Some initial scenarios for testing. *)
325 (* Do nothing, block devices could contain random stuff including
326 * LVM PVs, and some filesystems might be mounted. This is usually
331 (* Block devices are empty and no filesystems are mounted. *)
334 (* /dev/sda contains a single partition /dev/sda1, with random
335 * content. /dev/sdb and /dev/sdc may have random content.
340 (* /dev/sda contains a single partition /dev/sda1, which is formatted
341 * as ext2, empty [except for lost+found] and mounted on /.
342 * /dev/sdb and /dev/sdc may have random content.
348 * /dev/sda1 (is a PV):
349 * /dev/VG/LV (size 8MB):
350 * formatted as ext2, empty [except for lost+found], mounted on /
351 * /dev/sdb and /dev/sdc may have random content.
355 (* /dev/sdd (the ISO, see images/ directory in source)
360 (* Sequence of commands for testing. *)
362 and cmd = string list
364 (* Note about long descriptions: When referring to another
365 * action, use the format C<guestfs_other> (ie. the full name of
366 * the C function). This will be replaced as appropriate in other
369 * Apart from that, long descriptions are just perldoc paragraphs.
372 (* Generate a random UUID (used in tests). *)
374 let chan = open_process_in "uuidgen" in
375 let uuid = input_line chan in
376 (match close_process_in chan with
379 failwith "uuidgen: process exited with non-zero status"
380 | WSIGNALED _ | WSTOPPED _ ->
381 failwith "uuidgen: process signalled or stopped by signal"
385 (* These test functions are used in the language binding tests. *)
387 let test_all_args = [
390 StringList "strlist";
399 let test_all_rets = [
400 (* except for RErr, which is tested thoroughly elsewhere *)
401 "test0rint", RInt "valout";
402 "test0rint64", RInt64 "valout";
403 "test0rbool", RBool "valout";
404 "test0rconststring", RConstString "valout";
405 "test0rconstoptstring", RConstOptString "valout";
406 "test0rstring", RString "valout";
407 "test0rstringlist", RStringList "valout";
408 "test0rstruct", RStruct ("valout", "lvm_pv");
409 "test0rstructlist", RStructList ("valout", "lvm_pv");
410 "test0rhashtable", RHashtable "valout";
413 let test_functions = [
414 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
416 "internal test function - do not use",
418 This is an internal test function which is used to test whether
419 the automatically generated bindings can handle every possible
420 parameter type correctly.
422 It echos the contents of each parameter to stdout.
424 You probably don't want to call this function.");
428 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
430 "internal test function - do not use",
432 This is an internal test function which is used to test whether
433 the automatically generated bindings can handle every possible
434 return type correctly.
436 It converts string C<val> to the return type.
438 You probably don't want to call this function.");
439 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
441 "internal test function - do not use",
443 This is an internal test function which is used to test whether
444 the automatically generated bindings can handle every possible
445 return type correctly.
447 This function always returns an error.
449 You probably don't want to call this function.")]
453 (* non_daemon_functions are any functions which don't get processed
454 * in the daemon, eg. functions for setting and getting local
455 * configuration values.
458 let non_daemon_functions = test_functions @ [
459 ("launch", (RErr, []), -1, [FishAlias "run"],
461 "launch the qemu subprocess",
463 Internally libguestfs is implemented by running a virtual machine
466 You should call this after configuring the handle
467 (eg. adding drives) but before performing any actions.");
469 ("wait_ready", (RErr, []), -1, [NotInFish],
471 "wait until the qemu subprocess launches (no op)",
473 This function is a no op.
475 In versions of the API E<lt> 1.0.71 you had to call this function
476 just after calling C<guestfs_launch> to wait for the launch
477 to complete. However this is no longer necessary because
478 C<guestfs_launch> now does the waiting.
480 If you see any calls to this function in code then you can just
481 remove them, unless you want to retain compatibility with older
482 versions of the API.");
484 ("kill_subprocess", (RErr, []), -1, [],
486 "kill the qemu subprocess",
488 This kills the qemu subprocess. You should never need to call this.");
490 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
492 "add an image to examine or modify",
494 This function adds a virtual machine disk image C<filename> to the
495 guest. The first time you call this function, the disk appears as IDE
496 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
499 You don't necessarily need to be root when using libguestfs. However
500 you obviously do need sufficient permissions to access the filename
501 for whatever operations you want to perform (ie. read access if you
502 just want to read the image or write access if you want to modify the
505 This is equivalent to the qemu parameter
506 C<-drive file=filename,cache=off,if=...>.
508 C<cache=off> is omitted in cases where it is not supported by
509 the underlying filesystem.
511 C<if=...> is set at compile time by the configuration option
512 C<./configure --with-drive-if=...>. In the rare case where you
513 might need to change this at run time, use C<guestfs_add_drive_with_if>
514 or C<guestfs_add_drive_ro_with_if>.
516 Note that this call checks for the existence of C<filename>. This
517 stops you from specifying other types of drive which are supported
518 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
519 the general C<guestfs_config> call instead.");
521 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
523 "add a CD-ROM disk image to examine",
525 This function adds a virtual CD-ROM disk image to the guest.
527 This is equivalent to the qemu parameter C<-cdrom filename>.
535 This call checks for the existence of C<filename>. This
536 stops you from specifying other types of drive which are supported
537 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
538 the general C<guestfs_config> call instead.
542 If you just want to add an ISO file (often you use this as an
543 efficient way to transfer large files into the guest), then you
544 should probably use C<guestfs_add_drive_ro> instead.
548 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
550 "add a drive in snapshot mode (read-only)",
552 This adds a drive in snapshot mode, making it effectively
555 Note that writes to the device are allowed, and will be seen for
556 the duration of the guestfs handle, but they are written
557 to a temporary file which is discarded as soon as the guestfs
558 handle is closed. We don't currently have any method to enable
559 changes to be committed, although qemu can support this.
561 This is equivalent to the qemu parameter
562 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
564 C<if=...> is set at compile time by the configuration option
565 C<./configure --with-drive-if=...>. In the rare case where you
566 might need to change this at run time, use C<guestfs_add_drive_with_if>
567 or C<guestfs_add_drive_ro_with_if>.
569 C<readonly=on> is only added where qemu supports this option.
571 Note that this call checks for the existence of C<filename>. This
572 stops you from specifying other types of drive which are supported
573 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
574 the general C<guestfs_config> call instead.");
576 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
578 "add qemu parameters",
580 This can be used to add arbitrary qemu command line parameters
581 of the form C<-param value>. Actually it's not quite arbitrary - we
582 prevent you from setting some parameters which would interfere with
583 parameters that we use.
585 The first character of C<param> string must be a C<-> (dash).
587 C<value> can be NULL.");
589 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
591 "set the qemu binary",
593 Set the qemu binary that we will use.
595 The default is chosen when the library was compiled by the
598 You can also override this by setting the C<LIBGUESTFS_QEMU>
599 environment variable.
601 Setting C<qemu> to C<NULL> restores the default qemu binary.
603 Note that you should call this function as early as possible
604 after creating the handle. This is because some pre-launch
605 operations depend on testing qemu features (by running C<qemu -help>).
606 If the qemu binary changes, we don't retest features, and
607 so you might see inconsistent results. Using the environment
608 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
609 the qemu binary at the same time as the handle is created.");
611 ("get_qemu", (RConstString "qemu", []), -1, [],
612 [InitNone, Always, TestRun (
614 "get the qemu binary",
616 Return the current qemu binary.
618 This is always non-NULL. If it wasn't set already, then this will
619 return the default qemu binary name.");
621 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
623 "set the search path",
625 Set the path that libguestfs searches for kernel and initrd.img.
627 The default is C<$libdir/guestfs> unless overridden by setting
628 C<LIBGUESTFS_PATH> environment variable.
630 Setting C<path> to C<NULL> restores the default path.");
632 ("get_path", (RConstString "path", []), -1, [],
633 [InitNone, Always, TestRun (
635 "get the search path",
637 Return the current search path.
639 This is always non-NULL. If it wasn't set already, then this will
640 return the default path.");
642 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
644 "add options to kernel command line",
646 This function is used to add additional options to the
647 guest kernel command line.
649 The default is C<NULL> unless overridden by setting
650 C<LIBGUESTFS_APPEND> environment variable.
652 Setting C<append> to C<NULL> means I<no> additional options
653 are passed (libguestfs always adds a few of its own).");
655 ("get_append", (RConstOptString "append", []), -1, [],
656 (* This cannot be tested with the current framework. The
657 * function can return NULL in normal operations, which the
658 * test framework interprets as an error.
661 "get the additional kernel options",
663 Return the additional kernel options which are added to the
664 guest kernel command line.
666 If C<NULL> then no options are added.");
668 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
672 If C<autosync> is true, this enables autosync. Libguestfs will make a
673 best effort attempt to run C<guestfs_umount_all> followed by
674 C<guestfs_sync> when the handle is closed
675 (also if the program exits without closing handles).
677 This is disabled by default (except in guestfish where it is
678 enabled by default).");
680 ("get_autosync", (RBool "autosync", []), -1, [],
681 [InitNone, Always, TestRun (
682 [["get_autosync"]])],
685 Get the autosync flag.");
687 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
691 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
693 Verbose messages are disabled unless the environment variable
694 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
696 ("get_verbose", (RBool "verbose", []), -1, [],
700 This returns the verbose messages flag.");
702 ("is_ready", (RBool "ready", []), -1, [],
703 [InitNone, Always, TestOutputTrue (
705 "is ready to accept commands",
707 This returns true iff this handle is ready to accept commands
708 (in the C<READY> state).
710 For more information on states, see L<guestfs(3)>.");
712 ("is_config", (RBool "config", []), -1, [],
713 [InitNone, Always, TestOutputFalse (
715 "is in configuration state",
717 This returns true iff this handle is being configured
718 (in the C<CONFIG> state).
720 For more information on states, see L<guestfs(3)>.");
722 ("is_launching", (RBool "launching", []), -1, [],
723 [InitNone, Always, TestOutputFalse (
724 [["is_launching"]])],
725 "is launching subprocess",
727 This returns true iff this handle is launching the subprocess
728 (in the C<LAUNCHING> state).
730 For more information on states, see L<guestfs(3)>.");
732 ("is_busy", (RBool "busy", []), -1, [],
733 [InitNone, Always, TestOutputFalse (
735 "is busy processing a command",
737 This returns true iff this handle is busy processing a command
738 (in the C<BUSY> state).
740 For more information on states, see L<guestfs(3)>.");
742 ("get_state", (RInt "state", []), -1, [],
744 "get the current state",
746 This returns the current state as an opaque integer. This is
747 only useful for printing debug and internal error messages.
749 For more information on states, see L<guestfs(3)>.");
751 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
752 [InitNone, Always, TestOutputInt (
753 [["set_memsize"; "500"];
754 ["get_memsize"]], 500)],
755 "set memory allocated to the qemu subprocess",
757 This sets the memory size in megabytes allocated to the
758 qemu subprocess. This only has any effect if called before
761 You can also change this by setting the environment
762 variable C<LIBGUESTFS_MEMSIZE> before the handle is
765 For more information on the architecture of libguestfs,
766 see L<guestfs(3)>.");
768 ("get_memsize", (RInt "memsize", []), -1, [],
769 [InitNone, Always, TestOutputIntOp (
770 [["get_memsize"]], ">=", 256)],
771 "get memory allocated to the qemu subprocess",
773 This gets the memory size in megabytes allocated to the
776 If C<guestfs_set_memsize> was not called
777 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
778 then this returns the compiled-in default value for memsize.
780 For more information on the architecture of libguestfs,
781 see L<guestfs(3)>.");
783 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
784 [InitNone, Always, TestOutputIntOp (
785 [["get_pid"]], ">=", 1)],
786 "get PID of qemu subprocess",
788 Return the process ID of the qemu subprocess. If there is no
789 qemu subprocess, then this will return an error.
791 This is an internal call used for debugging and testing.");
793 ("version", (RStruct ("version", "version"), []), -1, [],
794 [InitNone, Always, TestOutputStruct (
795 [["version"]], [CompareWithInt ("major", 1)])],
796 "get the library version number",
798 Return the libguestfs version number that the program is linked
801 Note that because of dynamic linking this is not necessarily
802 the version of libguestfs that you compiled against. You can
803 compile the program, and then at runtime dynamically link
804 against a completely different C<libguestfs.so> library.
806 This call was added in version C<1.0.58>. In previous
807 versions of libguestfs there was no way to get the version
808 number. From C code you can use dynamic linker functions
809 to find out if this symbol exists (if it doesn't, then
810 it's an earlier version).
812 The call returns a structure with four elements. The first
813 three (C<major>, C<minor> and C<release>) are numbers and
814 correspond to the usual version triplet. The fourth element
815 (C<extra>) is a string and is normally empty, but may be
816 used for distro-specific information.
818 To construct the original version string:
819 C<$major.$minor.$release$extra>
821 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
823 I<Note:> Don't use this call to test for availability
824 of features. In enterprise distributions we backport
825 features from later versions into earlier versions,
826 making this an unreliable way to test for features.
827 Use C<guestfs_available> instead.");
829 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
830 [InitNone, Always, TestOutputTrue (
831 [["set_selinux"; "true"];
833 "set SELinux enabled or disabled at appliance boot",
835 This sets the selinux flag that is passed to the appliance
836 at boot time. The default is C<selinux=0> (disabled).
838 Note that if SELinux is enabled, it is always in
839 Permissive mode (C<enforcing=0>).
841 For more information on the architecture of libguestfs,
842 see L<guestfs(3)>.");
844 ("get_selinux", (RBool "selinux", []), -1, [],
846 "get SELinux enabled flag",
848 This returns the current setting of the selinux flag which
849 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
851 For more information on the architecture of libguestfs,
852 see L<guestfs(3)>.");
854 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
855 [InitNone, Always, TestOutputFalse (
856 [["set_trace"; "false"];
858 "enable or disable command traces",
860 If the command trace flag is set to 1, then commands are
861 printed on stdout before they are executed in a format
862 which is very similar to the one used by guestfish. In
863 other words, you can run a program with this enabled, and
864 you will get out a script which you can feed to guestfish
865 to perform the same set of actions.
867 If you want to trace C API calls into libguestfs (and
868 other libraries) then possibly a better way is to use
869 the external ltrace(1) command.
871 Command traces are disabled unless the environment variable
872 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
874 ("get_trace", (RBool "trace", []), -1, [],
876 "get command trace enabled flag",
878 Return the command trace flag.");
880 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
881 [InitNone, Always, TestOutputFalse (
882 [["set_direct"; "false"];
884 "enable or disable direct appliance mode",
886 If the direct appliance mode flag is enabled, then stdin and
887 stdout are passed directly through to the appliance once it
890 One consequence of this is that log messages aren't caught
891 by the library and handled by C<guestfs_set_log_message_callback>,
892 but go straight to stdout.
894 You probably don't want to use this unless you know what you
897 The default is disabled.");
899 ("get_direct", (RBool "direct", []), -1, [],
901 "get direct appliance mode flag",
903 Return the direct appliance mode flag.");
905 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
906 [InitNone, Always, TestOutputTrue (
907 [["set_recovery_proc"; "true"];
908 ["get_recovery_proc"]])],
909 "enable or disable the recovery process",
911 If this is called with the parameter C<false> then
912 C<guestfs_launch> does not create a recovery process. The
913 purpose of the recovery process is to stop runaway qemu
914 processes in the case where the main program aborts abruptly.
916 This only has any effect if called before C<guestfs_launch>,
917 and the default is true.
919 About the only time when you would want to disable this is
920 if the main process will fork itself into the background
921 (\"daemonize\" itself). In this case the recovery process
922 thinks that the main program has disappeared and so kills
923 qemu, which is not very helpful.");
925 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
927 "get recovery process enabled flag",
929 Return the recovery process enabled flag.");
931 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
933 "add a drive specifying the QEMU block emulation to use",
935 This is the same as C<guestfs_add_drive> but it allows you
936 to specify the QEMU interface emulation to use at run time.");
938 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
940 "add a drive read-only specifying the QEMU block emulation to use",
942 This is the same as C<guestfs_add_drive_ro> but it allows you
943 to specify the QEMU interface emulation to use at run time.");
947 (* daemon_functions are any functions which cause some action
948 * to take place in the daemon.
951 let daemon_functions = [
952 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
953 [InitEmpty, Always, TestOutput (
954 [["part_disk"; "/dev/sda"; "mbr"];
955 ["mkfs"; "ext2"; "/dev/sda1"];
956 ["mount"; "/dev/sda1"; "/"];
957 ["write"; "/new"; "new file contents"];
958 ["cat"; "/new"]], "new file contents")],
959 "mount a guest disk at a position in the filesystem",
961 Mount a guest disk at a position in the filesystem. Block devices
962 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
963 the guest. If those block devices contain partitions, they will have
964 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
967 The rules are the same as for L<mount(2)>: A filesystem must
968 first be mounted on C</> before others can be mounted. Other
969 filesystems can only be mounted on directories which already
972 The mounted filesystem is writable, if we have sufficient permissions
973 on the underlying device.
976 When you use this call, the filesystem options C<sync> and C<noatime>
977 are set implicitly. This was originally done because we thought it
978 would improve reliability, but it turns out that I<-o sync> has a
979 very large negative performance impact and negligible effect on
980 reliability. Therefore we recommend that you avoid using
981 C<guestfs_mount> in any code that needs performance, and instead
982 use C<guestfs_mount_options> (use an empty string for the first
983 parameter if you don't want any options).");
985 ("sync", (RErr, []), 2, [],
986 [ InitEmpty, Always, TestRun [["sync"]]],
987 "sync disks, writes are flushed through to the disk image",
989 This syncs the disk, so that any writes are flushed through to the
990 underlying disk image.
992 You should always call this if you have modified a disk image, before
993 closing the handle.");
995 ("touch", (RErr, [Pathname "path"]), 3, [],
996 [InitBasicFS, Always, TestOutputTrue (
998 ["exists"; "/new"]])],
999 "update file timestamps or create a new file",
1001 Touch acts like the L<touch(1)> command. It can be used to
1002 update the timestamps on a file, or, if the file does not exist,
1003 to create a new zero-length file.
1005 This command only works on regular files, and will fail on other
1006 file types such as directories, symbolic links, block special etc.");
1008 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
1009 [InitISOFS, Always, TestOutput (
1010 [["cat"; "/known-2"]], "abcdef\n")],
1011 "list the contents of a file",
1013 Return the contents of the file named C<path>.
1015 Note that this function cannot correctly handle binary files
1016 (specifically, files containing C<\\0> character which is treated
1017 as end of string). For those you need to use the C<guestfs_read_file>
1018 or C<guestfs_download> functions which have a more complex interface.");
1020 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1021 [], (* XXX Tricky to test because it depends on the exact format
1022 * of the 'ls -l' command, which changes between F10 and F11.
1024 "list the files in a directory (long format)",
1026 List the files in C<directory> (relative to the root directory,
1027 there is no cwd) in the format of 'ls -la'.
1029 This command is mostly useful for interactive sessions. It
1030 is I<not> intended that you try to parse the output string.");
1032 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1033 [InitBasicFS, Always, TestOutputList (
1035 ["touch"; "/newer"];
1036 ["touch"; "/newest"];
1037 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1038 "list the files in a directory",
1040 List the files in C<directory> (relative to the root directory,
1041 there is no cwd). The '.' and '..' entries are not returned, but
1042 hidden files are shown.
1044 This command is mostly useful for interactive sessions. Programs
1045 should probably use C<guestfs_readdir> instead.");
1047 ("list_devices", (RStringList "devices", []), 7, [],
1048 [InitEmpty, Always, TestOutputListOfDevices (
1049 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1050 "list the block devices",
1052 List all the block devices.
1054 The full block device names are returned, eg. C</dev/sda>");
1056 ("list_partitions", (RStringList "partitions", []), 8, [],
1057 [InitBasicFS, Always, TestOutputListOfDevices (
1058 [["list_partitions"]], ["/dev/sda1"]);
1059 InitEmpty, Always, TestOutputListOfDevices (
1060 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1061 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1062 "list the partitions",
1064 List all the partitions detected on all block devices.
1066 The full partition device names are returned, eg. C</dev/sda1>
1068 This does not return logical volumes. For that you will need to
1069 call C<guestfs_lvs>.");
1071 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1072 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1073 [["pvs"]], ["/dev/sda1"]);
1074 InitEmpty, Always, TestOutputListOfDevices (
1075 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1076 ["pvcreate"; "/dev/sda1"];
1077 ["pvcreate"; "/dev/sda2"];
1078 ["pvcreate"; "/dev/sda3"];
1079 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1080 "list the LVM physical volumes (PVs)",
1082 List all the physical volumes detected. This is the equivalent
1083 of the L<pvs(8)> command.
1085 This returns a list of just the device names that contain
1086 PVs (eg. C</dev/sda2>).
1088 See also C<guestfs_pvs_full>.");
1090 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1091 [InitBasicFSonLVM, Always, TestOutputList (
1093 InitEmpty, Always, TestOutputList (
1094 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1095 ["pvcreate"; "/dev/sda1"];
1096 ["pvcreate"; "/dev/sda2"];
1097 ["pvcreate"; "/dev/sda3"];
1098 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1099 ["vgcreate"; "VG2"; "/dev/sda3"];
1100 ["vgs"]], ["VG1"; "VG2"])],
1101 "list the LVM volume groups (VGs)",
1103 List all the volumes groups detected. This is the equivalent
1104 of the L<vgs(8)> command.
1106 This returns a list of just the volume group names that were
1107 detected (eg. C<VolGroup00>).
1109 See also C<guestfs_vgs_full>.");
1111 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1112 [InitBasicFSonLVM, Always, TestOutputList (
1113 [["lvs"]], ["/dev/VG/LV"]);
1114 InitEmpty, Always, TestOutputList (
1115 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1116 ["pvcreate"; "/dev/sda1"];
1117 ["pvcreate"; "/dev/sda2"];
1118 ["pvcreate"; "/dev/sda3"];
1119 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1120 ["vgcreate"; "VG2"; "/dev/sda3"];
1121 ["lvcreate"; "LV1"; "VG1"; "50"];
1122 ["lvcreate"; "LV2"; "VG1"; "50"];
1123 ["lvcreate"; "LV3"; "VG2"; "50"];
1124 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1125 "list the LVM logical volumes (LVs)",
1127 List all the logical volumes detected. This is the equivalent
1128 of the L<lvs(8)> command.
1130 This returns a list of the logical volume device names
1131 (eg. C</dev/VolGroup00/LogVol00>).
1133 See also C<guestfs_lvs_full>.");
1135 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1136 [], (* XXX how to test? *)
1137 "list the LVM physical volumes (PVs)",
1139 List all the physical volumes detected. This is the equivalent
1140 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1142 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1143 [], (* XXX how to test? *)
1144 "list the LVM volume groups (VGs)",
1146 List all the volumes groups detected. This is the equivalent
1147 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1149 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1150 [], (* XXX how to test? *)
1151 "list the LVM logical volumes (LVs)",
1153 List all the logical volumes detected. This is the equivalent
1154 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1156 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1157 [InitISOFS, Always, TestOutputList (
1158 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1159 InitISOFS, Always, TestOutputList (
1160 [["read_lines"; "/empty"]], [])],
1161 "read file as lines",
1163 Return the contents of the file named C<path>.
1165 The file contents are returned as a list of lines. Trailing
1166 C<LF> and C<CRLF> character sequences are I<not> returned.
1168 Note that this function cannot correctly handle binary files
1169 (specifically, files containing C<\\0> character which is treated
1170 as end of line). For those you need to use the C<guestfs_read_file>
1171 function which has a more complex interface.");
1173 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1174 [], (* XXX Augeas code needs tests. *)
1175 "create a new Augeas handle",
1177 Create a new Augeas handle for editing configuration files.
1178 If there was any previous Augeas handle associated with this
1179 guestfs session, then it is closed.
1181 You must call this before using any other C<guestfs_aug_*>
1184 C<root> is the filesystem root. C<root> must not be NULL,
1187 The flags are the same as the flags defined in
1188 E<lt>augeas.hE<gt>, the logical I<or> of the following
1193 =item C<AUG_SAVE_BACKUP> = 1
1195 Keep the original file with a C<.augsave> extension.
1197 =item C<AUG_SAVE_NEWFILE> = 2
1199 Save changes into a file with extension C<.augnew>, and
1200 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1202 =item C<AUG_TYPE_CHECK> = 4
1204 Typecheck lenses (can be expensive).
1206 =item C<AUG_NO_STDINC> = 8
1208 Do not use standard load path for modules.
1210 =item C<AUG_SAVE_NOOP> = 16
1212 Make save a no-op, just record what would have been changed.
1214 =item C<AUG_NO_LOAD> = 32
1216 Do not load the tree in C<guestfs_aug_init>.
1220 To close the handle, you can call C<guestfs_aug_close>.
1222 To find out more about Augeas, see L<http://augeas.net/>.");
1224 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1225 [], (* XXX Augeas code needs tests. *)
1226 "close the current Augeas handle",
1228 Close the current Augeas handle and free up any resources
1229 used by it. After calling this, you have to call
1230 C<guestfs_aug_init> again before you can use any other
1231 Augeas functions.");
1233 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1234 [], (* XXX Augeas code needs tests. *)
1235 "define an Augeas variable",
1237 Defines an Augeas variable C<name> whose value is the result
1238 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1241 On success this returns the number of nodes in C<expr>, or
1242 C<0> if C<expr> evaluates to something which is not a nodeset.");
1244 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1245 [], (* XXX Augeas code needs tests. *)
1246 "define an Augeas node",
1248 Defines a variable C<name> whose value is the result of
1251 If C<expr> evaluates to an empty nodeset, a node is created,
1252 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1253 C<name> will be the nodeset containing that single node.
1255 On success this returns a pair containing the
1256 number of nodes in the nodeset, and a boolean flag
1257 if a node was created.");
1259 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1260 [], (* XXX Augeas code needs tests. *)
1261 "look up the value of an Augeas path",
1263 Look up the value associated with C<path>. If C<path>
1264 matches exactly one node, the C<value> is returned.");
1266 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1267 [], (* XXX Augeas code needs tests. *)
1268 "set Augeas path to value",
1270 Set the value associated with C<path> to C<val>.
1272 In the Augeas API, it is possible to clear a node by setting
1273 the value to NULL. Due to an oversight in the libguestfs API
1274 you cannot do that with this call. Instead you must use the
1275 C<guestfs_aug_clear> call.");
1277 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1278 [], (* XXX Augeas code needs tests. *)
1279 "insert a sibling Augeas node",
1281 Create a new sibling C<label> for C<path>, inserting it into
1282 the tree before or after C<path> (depending on the boolean
1285 C<path> must match exactly one existing node in the tree, and
1286 C<label> must be a label, ie. not contain C</>, C<*> or end
1287 with a bracketed index C<[N]>.");
1289 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1290 [], (* XXX Augeas code needs tests. *)
1291 "remove an Augeas path",
1293 Remove C<path> and all of its children.
1295 On success this returns the number of entries which were removed.");
1297 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1298 [], (* XXX Augeas code needs tests. *)
1301 Move the node C<src> to C<dest>. C<src> must match exactly
1302 one node. C<dest> is overwritten if it exists.");
1304 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1305 [], (* XXX Augeas code needs tests. *)
1306 "return Augeas nodes which match augpath",
1308 Returns a list of paths which match the path expression C<path>.
1309 The returned paths are sufficiently qualified so that they match
1310 exactly one node in the current tree.");
1312 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1313 [], (* XXX Augeas code needs tests. *)
1314 "write all pending Augeas changes to disk",
1316 This writes all pending changes to disk.
1318 The flags which were passed to C<guestfs_aug_init> affect exactly
1319 how files are saved.");
1321 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1322 [], (* XXX Augeas code needs tests. *)
1323 "load files into the tree",
1325 Load files into the tree.
1327 See C<aug_load> in the Augeas documentation for the full gory
1330 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1331 [], (* XXX Augeas code needs tests. *)
1332 "list Augeas nodes under augpath",
1334 This is just a shortcut for listing C<guestfs_aug_match>
1335 C<path/*> and sorting the resulting nodes into alphabetical order.");
1337 ("rm", (RErr, [Pathname "path"]), 29, [],
1338 [InitBasicFS, Always, TestRun
1341 InitBasicFS, Always, TestLastFail
1343 InitBasicFS, Always, TestLastFail
1348 Remove the single file C<path>.");
1350 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1351 [InitBasicFS, Always, TestRun
1354 InitBasicFS, Always, TestLastFail
1355 [["rmdir"; "/new"]];
1356 InitBasicFS, Always, TestLastFail
1358 ["rmdir"; "/new"]]],
1359 "remove a directory",
1361 Remove the single directory C<path>.");
1363 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1364 [InitBasicFS, Always, TestOutputFalse
1366 ["mkdir"; "/new/foo"];
1367 ["touch"; "/new/foo/bar"];
1369 ["exists"; "/new"]]],
1370 "remove a file or directory recursively",
1372 Remove the file or directory C<path>, recursively removing the
1373 contents if its a directory. This is like the C<rm -rf> shell
1376 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1377 [InitBasicFS, Always, TestOutputTrue
1379 ["is_dir"; "/new"]];
1380 InitBasicFS, Always, TestLastFail
1381 [["mkdir"; "/new/foo/bar"]]],
1382 "create a directory",
1384 Create a directory named C<path>.");
1386 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1387 [InitBasicFS, Always, TestOutputTrue
1388 [["mkdir_p"; "/new/foo/bar"];
1389 ["is_dir"; "/new/foo/bar"]];
1390 InitBasicFS, Always, TestOutputTrue
1391 [["mkdir_p"; "/new/foo/bar"];
1392 ["is_dir"; "/new/foo"]];
1393 InitBasicFS, Always, TestOutputTrue
1394 [["mkdir_p"; "/new/foo/bar"];
1395 ["is_dir"; "/new"]];
1396 (* Regression tests for RHBZ#503133: *)
1397 InitBasicFS, Always, TestRun
1399 ["mkdir_p"; "/new"]];
1400 InitBasicFS, Always, TestLastFail
1402 ["mkdir_p"; "/new"]]],
1403 "create a directory and parents",
1405 Create a directory named C<path>, creating any parent directories
1406 as necessary. This is like the C<mkdir -p> shell command.");
1408 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1409 [], (* XXX Need stat command to test *)
1412 Change the mode (permissions) of C<path> to C<mode>. Only
1413 numeric modes are supported.
1415 I<Note>: When using this command from guestfish, C<mode>
1416 by default would be decimal, unless you prefix it with
1417 C<0> to get octal, ie. use C<0700> not C<700>.
1419 The mode actually set is affected by the umask.");
1421 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1422 [], (* XXX Need stat command to test *)
1423 "change file owner and group",
1425 Change the file owner to C<owner> and group to C<group>.
1427 Only numeric uid and gid are supported. If you want to use
1428 names, you will need to locate and parse the password file
1429 yourself (Augeas support makes this relatively easy).");
1431 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1432 [InitISOFS, Always, TestOutputTrue (
1433 [["exists"; "/empty"]]);
1434 InitISOFS, Always, TestOutputTrue (
1435 [["exists"; "/directory"]])],
1436 "test if file or directory exists",
1438 This returns C<true> if and only if there is a file, directory
1439 (or anything) with the given C<path> name.
1441 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1443 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1444 [InitISOFS, Always, TestOutputTrue (
1445 [["is_file"; "/known-1"]]);
1446 InitISOFS, Always, TestOutputFalse (
1447 [["is_file"; "/directory"]])],
1448 "test if file exists",
1450 This returns C<true> if and only if there is a file
1451 with the given C<path> name. Note that it returns false for
1452 other objects like directories.
1454 See also C<guestfs_stat>.");
1456 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1457 [InitISOFS, Always, TestOutputFalse (
1458 [["is_dir"; "/known-3"]]);
1459 InitISOFS, Always, TestOutputTrue (
1460 [["is_dir"; "/directory"]])],
1461 "test if file exists",
1463 This returns C<true> if and only if there is a directory
1464 with the given C<path> name. Note that it returns false for
1465 other objects like files.
1467 See also C<guestfs_stat>.");
1469 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1470 [InitEmpty, Always, TestOutputListOfDevices (
1471 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1472 ["pvcreate"; "/dev/sda1"];
1473 ["pvcreate"; "/dev/sda2"];
1474 ["pvcreate"; "/dev/sda3"];
1475 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1476 "create an LVM physical volume",
1478 This creates an LVM physical volume on the named C<device>,
1479 where C<device> should usually be a partition name such
1482 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [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 ["vgs"]], ["VG1"; "VG2"])],
1491 "create an LVM volume group",
1493 This creates an LVM volume group called C<volgroup>
1494 from the non-empty list of physical volumes C<physvols>.");
1496 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1497 [InitEmpty, Always, TestOutputList (
1498 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1499 ["pvcreate"; "/dev/sda1"];
1500 ["pvcreate"; "/dev/sda2"];
1501 ["pvcreate"; "/dev/sda3"];
1502 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1503 ["vgcreate"; "VG2"; "/dev/sda3"];
1504 ["lvcreate"; "LV1"; "VG1"; "50"];
1505 ["lvcreate"; "LV2"; "VG1"; "50"];
1506 ["lvcreate"; "LV3"; "VG2"; "50"];
1507 ["lvcreate"; "LV4"; "VG2"; "50"];
1508 ["lvcreate"; "LV5"; "VG2"; "50"];
1510 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1511 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1512 "create an LVM logical volume",
1514 This creates an LVM logical volume called C<logvol>
1515 on the volume group C<volgroup>, with C<size> megabytes.");
1517 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1518 [InitEmpty, Always, TestOutput (
1519 [["part_disk"; "/dev/sda"; "mbr"];
1520 ["mkfs"; "ext2"; "/dev/sda1"];
1521 ["mount_options"; ""; "/dev/sda1"; "/"];
1522 ["write"; "/new"; "new file contents"];
1523 ["cat"; "/new"]], "new file contents")],
1524 "make a filesystem",
1526 This creates a filesystem on C<device> (usually a partition
1527 or LVM logical volume). The filesystem type is C<fstype>, for
1530 ("sfdisk", (RErr, [Device "device";
1531 Int "cyls"; Int "heads"; Int "sectors";
1532 StringList "lines"]), 43, [DangerWillRobinson],
1534 "create partitions on a block device",
1536 This is a direct interface to the L<sfdisk(8)> program for creating
1537 partitions on block devices.
1539 C<device> should be a block device, for example C</dev/sda>.
1541 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1542 and sectors on the device, which are passed directly to sfdisk as
1543 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1544 of these, then the corresponding parameter is omitted. Usually for
1545 'large' disks, you can just pass C<0> for these, but for small
1546 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1547 out the right geometry and you will need to tell it.
1549 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1550 information refer to the L<sfdisk(8)> manpage.
1552 To create a single partition occupying the whole disk, you would
1553 pass C<lines> as a single element list, when the single element being
1554 the string C<,> (comma).
1556 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1557 C<guestfs_part_init>");
1559 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1560 (* Regression test for RHBZ#597135. *)
1561 [InitBasicFS, Always, TestLastFail
1562 [["write_file"; "/new"; "abc"; "10000"]]],
1565 This call creates a file called C<path>. The contents of the
1566 file is the string C<content> (which can contain any 8 bit data),
1567 with length C<size>.
1569 As a special case, if C<size> is C<0>
1570 then the length is calculated using C<strlen> (so in this case
1571 the content cannot contain embedded ASCII NULs).
1573 I<NB.> Owing to a bug, writing content containing ASCII NUL
1574 characters does I<not> work, even if the length is specified.");
1576 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1577 [InitEmpty, Always, TestOutputListOfDevices (
1578 [["part_disk"; "/dev/sda"; "mbr"];
1579 ["mkfs"; "ext2"; "/dev/sda1"];
1580 ["mount_options"; ""; "/dev/sda1"; "/"];
1581 ["mounts"]], ["/dev/sda1"]);
1582 InitEmpty, Always, TestOutputList (
1583 [["part_disk"; "/dev/sda"; "mbr"];
1584 ["mkfs"; "ext2"; "/dev/sda1"];
1585 ["mount_options"; ""; "/dev/sda1"; "/"];
1588 "unmount a filesystem",
1590 This unmounts the given filesystem. The filesystem may be
1591 specified either by its mountpoint (path) or the device which
1592 contains the filesystem.");
1594 ("mounts", (RStringList "devices", []), 46, [],
1595 [InitBasicFS, Always, TestOutputListOfDevices (
1596 [["mounts"]], ["/dev/sda1"])],
1597 "show mounted filesystems",
1599 This returns the list of currently mounted filesystems. It returns
1600 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1602 Some internal mounts are not shown.
1604 See also: C<guestfs_mountpoints>");
1606 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1607 [InitBasicFS, Always, TestOutputList (
1610 (* check that umount_all can unmount nested mounts correctly: *)
1611 InitEmpty, Always, TestOutputList (
1612 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1613 ["mkfs"; "ext2"; "/dev/sda1"];
1614 ["mkfs"; "ext2"; "/dev/sda2"];
1615 ["mkfs"; "ext2"; "/dev/sda3"];
1616 ["mount_options"; ""; "/dev/sda1"; "/"];
1618 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1619 ["mkdir"; "/mp1/mp2"];
1620 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1621 ["mkdir"; "/mp1/mp2/mp3"];
1624 "unmount all filesystems",
1626 This unmounts all mounted filesystems.
1628 Some internal mounts are not unmounted by this call.");
1630 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1632 "remove all LVM LVs, VGs and PVs",
1634 This command removes all LVM logical volumes, volume groups
1635 and physical volumes.");
1637 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1638 [InitISOFS, Always, TestOutput (
1639 [["file"; "/empty"]], "empty");
1640 InitISOFS, Always, TestOutput (
1641 [["file"; "/known-1"]], "ASCII text");
1642 InitISOFS, Always, TestLastFail (
1643 [["file"; "/notexists"]]);
1644 InitISOFS, Always, TestOutput (
1645 [["file"; "/abssymlink"]], "symbolic link");
1646 InitISOFS, Always, TestOutput (
1647 [["file"; "/directory"]], "directory")],
1648 "determine file type",
1650 This call uses the standard L<file(1)> command to determine
1651 the type or contents of the file.
1653 This call will also transparently look inside various types
1656 The exact command which runs is C<file -zb path>. Note in
1657 particular that the filename is not prepended to the output
1660 This command can also be used on C</dev/> devices
1661 (and partitions, LV names). You can for example use this
1662 to determine if a device contains a filesystem, although
1663 it's usually better to use C<guestfs_vfs_type>.
1665 If the C<path> does not begin with C</dev/> then
1666 this command only works for the content of regular files.
1667 For other file types (directory, symbolic link etc) it
1668 will just return the string C<directory> etc.");
1670 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1671 [InitBasicFS, Always, TestOutput (
1672 [["upload"; "test-command"; "/test-command"];
1673 ["chmod"; "0o755"; "/test-command"];
1674 ["command"; "/test-command 1"]], "Result1");
1675 InitBasicFS, Always, TestOutput (
1676 [["upload"; "test-command"; "/test-command"];
1677 ["chmod"; "0o755"; "/test-command"];
1678 ["command"; "/test-command 2"]], "Result2\n");
1679 InitBasicFS, Always, TestOutput (
1680 [["upload"; "test-command"; "/test-command"];
1681 ["chmod"; "0o755"; "/test-command"];
1682 ["command"; "/test-command 3"]], "\nResult3");
1683 InitBasicFS, Always, TestOutput (
1684 [["upload"; "test-command"; "/test-command"];
1685 ["chmod"; "0o755"; "/test-command"];
1686 ["command"; "/test-command 4"]], "\nResult4\n");
1687 InitBasicFS, Always, TestOutput (
1688 [["upload"; "test-command"; "/test-command"];
1689 ["chmod"; "0o755"; "/test-command"];
1690 ["command"; "/test-command 5"]], "\nResult5\n\n");
1691 InitBasicFS, Always, TestOutput (
1692 [["upload"; "test-command"; "/test-command"];
1693 ["chmod"; "0o755"; "/test-command"];
1694 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1695 InitBasicFS, Always, TestOutput (
1696 [["upload"; "test-command"; "/test-command"];
1697 ["chmod"; "0o755"; "/test-command"];
1698 ["command"; "/test-command 7"]], "");
1699 InitBasicFS, Always, TestOutput (
1700 [["upload"; "test-command"; "/test-command"];
1701 ["chmod"; "0o755"; "/test-command"];
1702 ["command"; "/test-command 8"]], "\n");
1703 InitBasicFS, Always, TestOutput (
1704 [["upload"; "test-command"; "/test-command"];
1705 ["chmod"; "0o755"; "/test-command"];
1706 ["command"; "/test-command 9"]], "\n\n");
1707 InitBasicFS, Always, TestOutput (
1708 [["upload"; "test-command"; "/test-command"];
1709 ["chmod"; "0o755"; "/test-command"];
1710 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1711 InitBasicFS, Always, TestOutput (
1712 [["upload"; "test-command"; "/test-command"];
1713 ["chmod"; "0o755"; "/test-command"];
1714 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1715 InitBasicFS, Always, TestLastFail (
1716 [["upload"; "test-command"; "/test-command"];
1717 ["chmod"; "0o755"; "/test-command"];
1718 ["command"; "/test-command"]])],
1719 "run a command from the guest filesystem",
1721 This call runs a command from the guest filesystem. The
1722 filesystem must be mounted, and must contain a compatible
1723 operating system (ie. something Linux, with the same
1724 or compatible processor architecture).
1726 The single parameter is an argv-style list of arguments.
1727 The first element is the name of the program to run.
1728 Subsequent elements are parameters. The list must be
1729 non-empty (ie. must contain a program name). Note that
1730 the command runs directly, and is I<not> invoked via
1731 the shell (see C<guestfs_sh>).
1733 The return value is anything printed to I<stdout> by
1736 If the command returns a non-zero exit status, then
1737 this function returns an error message. The error message
1738 string is the content of I<stderr> from the command.
1740 The C<$PATH> environment variable will contain at least
1741 C</usr/bin> and C</bin>. If you require a program from
1742 another location, you should provide the full path in the
1745 Shared libraries and data files required by the program
1746 must be available on filesystems which are mounted in the
1747 correct places. It is the caller's responsibility to ensure
1748 all filesystems that are needed are mounted at the right
1751 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1752 [InitBasicFS, Always, TestOutputList (
1753 [["upload"; "test-command"; "/test-command"];
1754 ["chmod"; "0o755"; "/test-command"];
1755 ["command_lines"; "/test-command 1"]], ["Result1"]);
1756 InitBasicFS, Always, TestOutputList (
1757 [["upload"; "test-command"; "/test-command"];
1758 ["chmod"; "0o755"; "/test-command"];
1759 ["command_lines"; "/test-command 2"]], ["Result2"]);
1760 InitBasicFS, Always, TestOutputList (
1761 [["upload"; "test-command"; "/test-command"];
1762 ["chmod"; "0o755"; "/test-command"];
1763 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1764 InitBasicFS, Always, TestOutputList (
1765 [["upload"; "test-command"; "/test-command"];
1766 ["chmod"; "0o755"; "/test-command"];
1767 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1768 InitBasicFS, Always, TestOutputList (
1769 [["upload"; "test-command"; "/test-command"];
1770 ["chmod"; "0o755"; "/test-command"];
1771 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1772 InitBasicFS, Always, TestOutputList (
1773 [["upload"; "test-command"; "/test-command"];
1774 ["chmod"; "0o755"; "/test-command"];
1775 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1776 InitBasicFS, Always, TestOutputList (
1777 [["upload"; "test-command"; "/test-command"];
1778 ["chmod"; "0o755"; "/test-command"];
1779 ["command_lines"; "/test-command 7"]], []);
1780 InitBasicFS, Always, TestOutputList (
1781 [["upload"; "test-command"; "/test-command"];
1782 ["chmod"; "0o755"; "/test-command"];
1783 ["command_lines"; "/test-command 8"]], [""]);
1784 InitBasicFS, Always, TestOutputList (
1785 [["upload"; "test-command"; "/test-command"];
1786 ["chmod"; "0o755"; "/test-command"];
1787 ["command_lines"; "/test-command 9"]], ["";""]);
1788 InitBasicFS, Always, TestOutputList (
1789 [["upload"; "test-command"; "/test-command"];
1790 ["chmod"; "0o755"; "/test-command"];
1791 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1792 InitBasicFS, Always, TestOutputList (
1793 [["upload"; "test-command"; "/test-command"];
1794 ["chmod"; "0o755"; "/test-command"];
1795 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1796 "run a command, returning lines",
1798 This is the same as C<guestfs_command>, but splits the
1799 result into a list of lines.
1801 See also: C<guestfs_sh_lines>");
1803 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1804 [InitISOFS, Always, TestOutputStruct (
1805 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1806 "get file information",
1808 Returns file information for the given C<path>.
1810 This is the same as the C<stat(2)> system call.");
1812 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1813 [InitISOFS, Always, TestOutputStruct (
1814 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1815 "get file information for a symbolic link",
1817 Returns file information for the given C<path>.
1819 This is the same as C<guestfs_stat> except that if C<path>
1820 is a symbolic link, then the link is stat-ed, not the file it
1823 This is the same as the C<lstat(2)> system call.");
1825 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1826 [InitISOFS, Always, TestOutputStruct (
1827 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1828 "get file system statistics",
1830 Returns file system statistics for any mounted file system.
1831 C<path> should be a file or directory in the mounted file system
1832 (typically it is the mount point itself, but it doesn't need to be).
1834 This is the same as the C<statvfs(2)> system call.");
1836 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1838 "get ext2/ext3/ext4 superblock details",
1840 This returns the contents of the ext2, ext3 or ext4 filesystem
1841 superblock on C<device>.
1843 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1844 manpage for more details. The list of fields returned isn't
1845 clearly defined, and depends on both the version of C<tune2fs>
1846 that libguestfs was built against, and the filesystem itself.");
1848 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1849 [InitEmpty, Always, TestOutputTrue (
1850 [["blockdev_setro"; "/dev/sda"];
1851 ["blockdev_getro"; "/dev/sda"]])],
1852 "set block device to read-only",
1854 Sets the block device named C<device> to read-only.
1856 This uses the L<blockdev(8)> command.");
1858 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1859 [InitEmpty, Always, TestOutputFalse (
1860 [["blockdev_setrw"; "/dev/sda"];
1861 ["blockdev_getro"; "/dev/sda"]])],
1862 "set block device to read-write",
1864 Sets the block device named C<device> to read-write.
1866 This uses the L<blockdev(8)> command.");
1868 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1869 [InitEmpty, Always, TestOutputTrue (
1870 [["blockdev_setro"; "/dev/sda"];
1871 ["blockdev_getro"; "/dev/sda"]])],
1872 "is block device set to read-only",
1874 Returns a boolean indicating if the block device is read-only
1875 (true if read-only, false if not).
1877 This uses the L<blockdev(8)> command.");
1879 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1880 [InitEmpty, Always, TestOutputInt (
1881 [["blockdev_getss"; "/dev/sda"]], 512)],
1882 "get sectorsize of block device",
1884 This returns the size of sectors on a block device.
1885 Usually 512, but can be larger for modern devices.
1887 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1890 This uses the L<blockdev(8)> command.");
1892 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1893 [InitEmpty, Always, TestOutputInt (
1894 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1895 "get blocksize of block device",
1897 This returns the block size of a device.
1899 (Note this is different from both I<size in blocks> and
1900 I<filesystem block size>).
1902 This uses the L<blockdev(8)> command.");
1904 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1906 "set blocksize of block device",
1908 This sets the block size of a device.
1910 (Note this is different from both I<size in blocks> and
1911 I<filesystem block size>).
1913 This uses the L<blockdev(8)> command.");
1915 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1916 [InitEmpty, Always, TestOutputInt (
1917 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1918 "get total size of device in 512-byte sectors",
1920 This returns the size of the device in units of 512-byte sectors
1921 (even if the sectorsize isn't 512 bytes ... weird).
1923 See also C<guestfs_blockdev_getss> for the real sector size of
1924 the device, and C<guestfs_blockdev_getsize64> for the more
1925 useful I<size in bytes>.
1927 This uses the L<blockdev(8)> command.");
1929 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1930 [InitEmpty, Always, TestOutputInt (
1931 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1932 "get total size of device in bytes",
1934 This returns the size of the device in bytes.
1936 See also C<guestfs_blockdev_getsz>.
1938 This uses the L<blockdev(8)> command.");
1940 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1941 [InitEmpty, Always, TestRun
1942 [["blockdev_flushbufs"; "/dev/sda"]]],
1943 "flush device buffers",
1945 This tells the kernel to flush internal buffers associated
1948 This uses the L<blockdev(8)> command.");
1950 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1951 [InitEmpty, Always, TestRun
1952 [["blockdev_rereadpt"; "/dev/sda"]]],
1953 "reread partition table",
1955 Reread the partition table on C<device>.
1957 This uses the L<blockdev(8)> command.");
1959 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1960 [InitBasicFS, Always, TestOutput (
1961 (* Pick a file from cwd which isn't likely to change. *)
1962 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1963 ["checksum"; "md5"; "/COPYING.LIB"]],
1964 Digest.to_hex (Digest.file "COPYING.LIB"))],
1965 "upload a file from the local machine",
1967 Upload local file C<filename> to C<remotefilename> on the
1970 C<filename> can also be a named pipe.
1972 See also C<guestfs_download>.");
1974 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1975 [InitBasicFS, Always, TestOutput (
1976 (* Pick a file from cwd which isn't likely to change. *)
1977 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1978 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1979 ["upload"; "testdownload.tmp"; "/upload"];
1980 ["checksum"; "md5"; "/upload"]],
1981 Digest.to_hex (Digest.file "COPYING.LIB"))],
1982 "download a file to the local machine",
1984 Download file C<remotefilename> and save it as C<filename>
1985 on the local machine.
1987 C<filename> can also be a named pipe.
1989 See also C<guestfs_upload>, C<guestfs_cat>.");
1991 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1992 [InitISOFS, Always, TestOutput (
1993 [["checksum"; "crc"; "/known-3"]], "2891671662");
1994 InitISOFS, Always, TestLastFail (
1995 [["checksum"; "crc"; "/notexists"]]);
1996 InitISOFS, Always, TestOutput (
1997 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1998 InitISOFS, Always, TestOutput (
1999 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
2000 InitISOFS, Always, TestOutput (
2001 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2002 InitISOFS, Always, TestOutput (
2003 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2004 InitISOFS, Always, TestOutput (
2005 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2006 InitISOFS, Always, TestOutput (
2007 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2008 (* Test for RHBZ#579608, absolute symbolic links. *)
2009 InitISOFS, Always, TestOutput (
2010 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2011 "compute MD5, SHAx or CRC checksum of file",
2013 This call computes the MD5, SHAx or CRC checksum of the
2016 The type of checksum to compute is given by the C<csumtype>
2017 parameter which must have one of the following values:
2023 Compute the cyclic redundancy check (CRC) specified by POSIX
2024 for the C<cksum> command.
2028 Compute the MD5 hash (using the C<md5sum> program).
2032 Compute the SHA1 hash (using the C<sha1sum> program).
2036 Compute the SHA224 hash (using the C<sha224sum> program).
2040 Compute the SHA256 hash (using the C<sha256sum> program).
2044 Compute the SHA384 hash (using the C<sha384sum> program).
2048 Compute the SHA512 hash (using the C<sha512sum> program).
2052 The checksum is returned as a printable string.
2054 To get the checksum for a device, use C<guestfs_checksum_device>.
2056 To get the checksums for many files, use C<guestfs_checksums_out>.");
2058 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2059 [InitBasicFS, Always, TestOutput (
2060 [["tar_in"; "../images/helloworld.tar"; "/"];
2061 ["cat"; "/hello"]], "hello\n")],
2062 "unpack tarfile to directory",
2064 This command uploads and unpacks local file C<tarfile> (an
2065 I<uncompressed> tar file) into C<directory>.
2067 To upload a compressed tarball, use C<guestfs_tgz_in>
2068 or C<guestfs_txz_in>.");
2070 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2072 "pack directory into tarfile",
2074 This command packs the contents of C<directory> and downloads
2075 it to local file C<tarfile>.
2077 To download a compressed tarball, use C<guestfs_tgz_out>
2078 or C<guestfs_txz_out>.");
2080 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2081 [InitBasicFS, Always, TestOutput (
2082 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2083 ["cat"; "/hello"]], "hello\n")],
2084 "unpack compressed tarball to directory",
2086 This command uploads and unpacks local file C<tarball> (a
2087 I<gzip compressed> tar file) into C<directory>.
2089 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2091 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2093 "pack directory into compressed tarball",
2095 This command packs the contents of C<directory> and downloads
2096 it to local file C<tarball>.
2098 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2100 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2101 [InitBasicFS, Always, TestLastFail (
2103 ["mount_ro"; "/dev/sda1"; "/"];
2104 ["touch"; "/new"]]);
2105 InitBasicFS, Always, TestOutput (
2106 [["write"; "/new"; "data"];
2108 ["mount_ro"; "/dev/sda1"; "/"];
2109 ["cat"; "/new"]], "data")],
2110 "mount a guest disk, read-only",
2112 This is the same as the C<guestfs_mount> command, but it
2113 mounts the filesystem with the read-only (I<-o ro>) flag.");
2115 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2117 "mount a guest disk with mount options",
2119 This is the same as the C<guestfs_mount> command, but it
2120 allows you to set the mount options as for the
2121 L<mount(8)> I<-o> flag.
2123 If the C<options> parameter is an empty string, then
2124 no options are passed (all options default to whatever
2125 the filesystem uses).");
2127 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2129 "mount a guest disk with mount options and vfstype",
2131 This is the same as the C<guestfs_mount> command, but it
2132 allows you to set both the mount options and the vfstype
2133 as for the L<mount(8)> I<-o> and I<-t> flags.");
2135 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2137 "debugging and internals",
2139 The C<guestfs_debug> command exposes some internals of
2140 C<guestfsd> (the guestfs daemon) that runs inside the
2143 There is no comprehensive help for this command. You have
2144 to look at the file C<daemon/debug.c> in the libguestfs source
2145 to find out what you can do.");
2147 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2148 [InitEmpty, Always, TestOutputList (
2149 [["part_disk"; "/dev/sda"; "mbr"];
2150 ["pvcreate"; "/dev/sda1"];
2151 ["vgcreate"; "VG"; "/dev/sda1"];
2152 ["lvcreate"; "LV1"; "VG"; "50"];
2153 ["lvcreate"; "LV2"; "VG"; "50"];
2154 ["lvremove"; "/dev/VG/LV1"];
2155 ["lvs"]], ["/dev/VG/LV2"]);
2156 InitEmpty, Always, TestOutputList (
2157 [["part_disk"; "/dev/sda"; "mbr"];
2158 ["pvcreate"; "/dev/sda1"];
2159 ["vgcreate"; "VG"; "/dev/sda1"];
2160 ["lvcreate"; "LV1"; "VG"; "50"];
2161 ["lvcreate"; "LV2"; "VG"; "50"];
2162 ["lvremove"; "/dev/VG"];
2164 InitEmpty, Always, TestOutputList (
2165 [["part_disk"; "/dev/sda"; "mbr"];
2166 ["pvcreate"; "/dev/sda1"];
2167 ["vgcreate"; "VG"; "/dev/sda1"];
2168 ["lvcreate"; "LV1"; "VG"; "50"];
2169 ["lvcreate"; "LV2"; "VG"; "50"];
2170 ["lvremove"; "/dev/VG"];
2172 "remove an LVM logical volume",
2174 Remove an LVM logical volume C<device>, where C<device> is
2175 the path to the LV, such as C</dev/VG/LV>.
2177 You can also remove all LVs in a volume group by specifying
2178 the VG name, C</dev/VG>.");
2180 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2181 [InitEmpty, Always, TestOutputList (
2182 [["part_disk"; "/dev/sda"; "mbr"];
2183 ["pvcreate"; "/dev/sda1"];
2184 ["vgcreate"; "VG"; "/dev/sda1"];
2185 ["lvcreate"; "LV1"; "VG"; "50"];
2186 ["lvcreate"; "LV2"; "VG"; "50"];
2189 InitEmpty, Always, TestOutputList (
2190 [["part_disk"; "/dev/sda"; "mbr"];
2191 ["pvcreate"; "/dev/sda1"];
2192 ["vgcreate"; "VG"; "/dev/sda1"];
2193 ["lvcreate"; "LV1"; "VG"; "50"];
2194 ["lvcreate"; "LV2"; "VG"; "50"];
2197 "remove an LVM volume group",
2199 Remove an LVM volume group C<vgname>, (for example C<VG>).
2201 This also forcibly removes all logical volumes in the volume
2204 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2205 [InitEmpty, Always, TestOutputListOfDevices (
2206 [["part_disk"; "/dev/sda"; "mbr"];
2207 ["pvcreate"; "/dev/sda1"];
2208 ["vgcreate"; "VG"; "/dev/sda1"];
2209 ["lvcreate"; "LV1"; "VG"; "50"];
2210 ["lvcreate"; "LV2"; "VG"; "50"];
2212 ["pvremove"; "/dev/sda1"];
2214 InitEmpty, Always, TestOutputListOfDevices (
2215 [["part_disk"; "/dev/sda"; "mbr"];
2216 ["pvcreate"; "/dev/sda1"];
2217 ["vgcreate"; "VG"; "/dev/sda1"];
2218 ["lvcreate"; "LV1"; "VG"; "50"];
2219 ["lvcreate"; "LV2"; "VG"; "50"];
2221 ["pvremove"; "/dev/sda1"];
2223 InitEmpty, Always, TestOutputListOfDevices (
2224 [["part_disk"; "/dev/sda"; "mbr"];
2225 ["pvcreate"; "/dev/sda1"];
2226 ["vgcreate"; "VG"; "/dev/sda1"];
2227 ["lvcreate"; "LV1"; "VG"; "50"];
2228 ["lvcreate"; "LV2"; "VG"; "50"];
2230 ["pvremove"; "/dev/sda1"];
2232 "remove an LVM physical volume",
2234 This wipes a physical volume C<device> so that LVM will no longer
2237 The implementation uses the C<pvremove> command which refuses to
2238 wipe physical volumes that contain any volume groups, so you have
2239 to remove those first.");
2241 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2242 [InitBasicFS, Always, TestOutput (
2243 [["set_e2label"; "/dev/sda1"; "testlabel"];
2244 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2245 "set the ext2/3/4 filesystem label",
2247 This sets the ext2/3/4 filesystem label of the filesystem on
2248 C<device> to C<label>. Filesystem labels are limited to
2251 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2252 to return the existing label on a filesystem.");
2254 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2256 "get the ext2/3/4 filesystem label",
2258 This returns the ext2/3/4 filesystem label of the filesystem on
2261 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2262 (let uuid = uuidgen () in
2263 [InitBasicFS, Always, TestOutput (
2264 [["set_e2uuid"; "/dev/sda1"; uuid];
2265 ["get_e2uuid"; "/dev/sda1"]], uuid);
2266 InitBasicFS, Always, TestOutput (
2267 [["set_e2uuid"; "/dev/sda1"; "clear"];
2268 ["get_e2uuid"; "/dev/sda1"]], "");
2269 (* We can't predict what UUIDs will be, so just check the commands run. *)
2270 InitBasicFS, Always, TestRun (
2271 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2272 InitBasicFS, Always, TestRun (
2273 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2274 "set the ext2/3/4 filesystem UUID",
2276 This sets the ext2/3/4 filesystem UUID of the filesystem on
2277 C<device> to C<uuid>. The format of the UUID and alternatives
2278 such as C<clear>, C<random> and C<time> are described in the
2279 L<tune2fs(8)> manpage.
2281 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2282 to return the existing UUID of a filesystem.");
2284 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2285 (* Regression test for RHBZ#597112. *)
2286 (let uuid = uuidgen () in
2287 [InitBasicFS, Always, TestOutput (
2288 [["mke2journal"; "1024"; "/dev/sdb"];
2289 ["set_e2uuid"; "/dev/sdb"; uuid];
2290 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2291 "get the ext2/3/4 filesystem UUID",
2293 This returns the ext2/3/4 filesystem UUID of the filesystem on
2296 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2297 [InitBasicFS, Always, TestOutputInt (
2298 [["umount"; "/dev/sda1"];
2299 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2300 InitBasicFS, Always, TestOutputInt (
2301 [["umount"; "/dev/sda1"];
2302 ["zero"; "/dev/sda1"];
2303 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2304 "run the filesystem checker",
2306 This runs the filesystem checker (fsck) on C<device> which
2307 should have filesystem type C<fstype>.
2309 The returned integer is the status. See L<fsck(8)> for the
2310 list of status codes from C<fsck>.
2318 Multiple status codes can be summed together.
2322 A non-zero return code can mean \"success\", for example if
2323 errors have been corrected on the filesystem.
2327 Checking or repairing NTFS volumes is not supported
2332 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2334 ("zero", (RErr, [Device "device"]), 85, [],
2335 [InitBasicFS, Always, TestOutput (
2336 [["umount"; "/dev/sda1"];
2337 ["zero"; "/dev/sda1"];
2338 ["file"; "/dev/sda1"]], "data")],
2339 "write zeroes to the device",
2341 This command writes zeroes over the first few blocks of C<device>.
2343 How many blocks are zeroed isn't specified (but it's I<not> enough
2344 to securely wipe the device). It should be sufficient to remove
2345 any partition tables, filesystem superblocks and so on.
2347 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2349 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2351 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2352 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2354 [InitBasicFS, Always, TestOutputTrue (
2355 [["mkdir_p"; "/boot/grub"];
2356 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2357 ["grub_install"; "/"; "/dev/vda"];
2358 ["is_dir"; "/boot"]])],
2361 This command installs GRUB (the Grand Unified Bootloader) on
2362 C<device>, with the root directory being C<root>.
2364 Note: If grub-install reports the error
2365 \"No suitable drive was found in the generated device map.\"
2366 it may be that you need to create a C</boot/grub/device.map>
2367 file first that contains the mapping between grub device names
2368 and Linux device names. It is usually sufficient to create
2373 replacing C</dev/vda> with the name of the installation device.");
2375 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2376 [InitBasicFS, Always, TestOutput (
2377 [["write"; "/old"; "file content"];
2378 ["cp"; "/old"; "/new"];
2379 ["cat"; "/new"]], "file content");
2380 InitBasicFS, Always, TestOutputTrue (
2381 [["write"; "/old"; "file content"];
2382 ["cp"; "/old"; "/new"];
2383 ["is_file"; "/old"]]);
2384 InitBasicFS, Always, TestOutput (
2385 [["write"; "/old"; "file content"];
2387 ["cp"; "/old"; "/dir/new"];
2388 ["cat"; "/dir/new"]], "file content")],
2391 This copies a file from C<src> to C<dest> where C<dest> is
2392 either a destination filename or destination directory.");
2394 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2395 [InitBasicFS, Always, TestOutput (
2396 [["mkdir"; "/olddir"];
2397 ["mkdir"; "/newdir"];
2398 ["write"; "/olddir/file"; "file content"];
2399 ["cp_a"; "/olddir"; "/newdir"];
2400 ["cat"; "/newdir/olddir/file"]], "file content")],
2401 "copy a file or directory recursively",
2403 This copies a file or directory from C<src> to C<dest>
2404 recursively using the C<cp -a> command.");
2406 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2407 [InitBasicFS, Always, TestOutput (
2408 [["write"; "/old"; "file content"];
2409 ["mv"; "/old"; "/new"];
2410 ["cat"; "/new"]], "file content");
2411 InitBasicFS, Always, TestOutputFalse (
2412 [["write"; "/old"; "file content"];
2413 ["mv"; "/old"; "/new"];
2414 ["is_file"; "/old"]])],
2417 This moves a file from C<src> to C<dest> where C<dest> is
2418 either a destination filename or destination directory.");
2420 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2421 [InitEmpty, Always, TestRun (
2422 [["drop_caches"; "3"]])],
2423 "drop kernel page cache, dentries and inodes",
2425 This instructs the guest kernel to drop its page cache,
2426 and/or dentries and inode caches. The parameter C<whattodrop>
2427 tells the kernel what precisely to drop, see
2428 L<http://linux-mm.org/Drop_Caches>
2430 Setting C<whattodrop> to 3 should drop everything.
2432 This automatically calls L<sync(2)> before the operation,
2433 so that the maximum guest memory is freed.");
2435 ("dmesg", (RString "kmsgs", []), 91, [],
2436 [InitEmpty, Always, TestRun (
2438 "return kernel messages",
2440 This returns the kernel messages (C<dmesg> output) from
2441 the guest kernel. This is sometimes useful for extended
2442 debugging of problems.
2444 Another way to get the same information is to enable
2445 verbose messages with C<guestfs_set_verbose> or by setting
2446 the environment variable C<LIBGUESTFS_DEBUG=1> before
2447 running the program.");
2449 ("ping_daemon", (RErr, []), 92, [],
2450 [InitEmpty, Always, TestRun (
2451 [["ping_daemon"]])],
2452 "ping the guest daemon",
2454 This is a test probe into the guestfs daemon running inside
2455 the qemu subprocess. Calling this function checks that the
2456 daemon responds to the ping message, without affecting the daemon
2457 or attached block device(s) in any other way.");
2459 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2460 [InitBasicFS, Always, TestOutputTrue (
2461 [["write"; "/file1"; "contents of a file"];
2462 ["cp"; "/file1"; "/file2"];
2463 ["equal"; "/file1"; "/file2"]]);
2464 InitBasicFS, Always, TestOutputFalse (
2465 [["write"; "/file1"; "contents of a file"];
2466 ["write"; "/file2"; "contents of another file"];
2467 ["equal"; "/file1"; "/file2"]]);
2468 InitBasicFS, Always, TestLastFail (
2469 [["equal"; "/file1"; "/file2"]])],
2470 "test if two files have equal contents",
2472 This compares the two files C<file1> and C<file2> and returns
2473 true if their content is exactly equal, or false otherwise.
2475 The external L<cmp(1)> program is used for the comparison.");
2477 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2478 [InitISOFS, Always, TestOutputList (
2479 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2480 InitISOFS, Always, TestOutputList (
2481 [["strings"; "/empty"]], []);
2482 (* Test for RHBZ#579608, absolute symbolic links. *)
2483 InitISOFS, Always, TestRun (
2484 [["strings"; "/abssymlink"]])],
2485 "print the printable strings in a file",
2487 This runs the L<strings(1)> command on a file and returns
2488 the list of printable strings found.");
2490 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2491 [InitISOFS, Always, TestOutputList (
2492 [["strings_e"; "b"; "/known-5"]], []);
2493 InitBasicFS, Always, TestOutputList (
2494 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2495 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2496 "print the printable strings in a file",
2498 This is like the C<guestfs_strings> command, but allows you to
2499 specify the encoding of strings that are looked for in
2500 the source file C<path>.
2502 Allowed encodings are:
2508 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2509 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2513 Single 8-bit-byte characters.
2517 16-bit big endian strings such as those encoded in
2518 UTF-16BE or UCS-2BE.
2520 =item l (lower case letter L)
2522 16-bit little endian such as UTF-16LE and UCS-2LE.
2523 This is useful for examining binaries in Windows guests.
2527 32-bit big endian such as UCS-4BE.
2531 32-bit little endian such as UCS-4LE.
2535 The returned strings are transcoded to UTF-8.");
2537 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2538 [InitISOFS, Always, TestOutput (
2539 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2540 (* Test for RHBZ#501888c2 regression which caused large hexdump
2541 * commands to segfault.
2543 InitISOFS, Always, TestRun (
2544 [["hexdump"; "/100krandom"]]);
2545 (* Test for RHBZ#579608, absolute symbolic links. *)
2546 InitISOFS, Always, TestRun (
2547 [["hexdump"; "/abssymlink"]])],
2548 "dump a file in hexadecimal",
2550 This runs C<hexdump -C> on the given C<path>. The result is
2551 the human-readable, canonical hex dump of the file.");
2553 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2554 [InitNone, Always, TestOutput (
2555 [["part_disk"; "/dev/sda"; "mbr"];
2556 ["mkfs"; "ext3"; "/dev/sda1"];
2557 ["mount_options"; ""; "/dev/sda1"; "/"];
2558 ["write"; "/new"; "test file"];
2559 ["umount"; "/dev/sda1"];
2560 ["zerofree"; "/dev/sda1"];
2561 ["mount_options"; ""; "/dev/sda1"; "/"];
2562 ["cat"; "/new"]], "test file")],
2563 "zero unused inodes and disk blocks on ext2/3 filesystem",
2565 This runs the I<zerofree> program on C<device>. This program
2566 claims to zero unused inodes and disk blocks on an ext2/3
2567 filesystem, thus making it possible to compress the filesystem
2570 You should B<not> run this program if the filesystem is
2573 It is possible that using this program can damage the filesystem
2574 or data on the filesystem.");
2576 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2578 "resize an LVM physical volume",
2580 This resizes (expands or shrinks) an existing LVM physical
2581 volume to match the new size of the underlying device.");
2583 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2584 Int "cyls"; Int "heads"; Int "sectors";
2585 String "line"]), 99, [DangerWillRobinson],
2587 "modify a single partition on a block device",
2589 This runs L<sfdisk(8)> option to modify just the single
2590 partition C<n> (note: C<n> counts from 1).
2592 For other parameters, see C<guestfs_sfdisk>. You should usually
2593 pass C<0> for the cyls/heads/sectors parameters.
2595 See also: C<guestfs_part_add>");
2597 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2599 "display the partition table",
2601 This displays the partition table on C<device>, in the
2602 human-readable output of the L<sfdisk(8)> command. It is
2603 not intended to be parsed.
2605 See also: C<guestfs_part_list>");
2607 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2609 "display the kernel geometry",
2611 This displays the kernel's idea of the geometry of C<device>.
2613 The result is in human-readable format, and not designed to
2616 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2618 "display the disk geometry from the partition table",
2620 This displays the disk geometry of C<device> read from the
2621 partition table. Especially in the case where the underlying
2622 block device has been resized, this can be different from the
2623 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2625 The result is in human-readable format, and not designed to
2628 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2630 "activate or deactivate all volume groups",
2632 This command activates or (if C<activate> is false) deactivates
2633 all logical volumes in all volume groups.
2634 If activated, then they are made known to the
2635 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2636 then those devices disappear.
2638 This command is the same as running C<vgchange -a y|n>");
2640 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2642 "activate or deactivate some volume groups",
2644 This command activates or (if C<activate> is false) deactivates
2645 all logical volumes in the listed volume groups C<volgroups>.
2646 If activated, then they are made known to the
2647 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2648 then those devices disappear.
2650 This command is the same as running C<vgchange -a y|n volgroups...>
2652 Note that if C<volgroups> is an empty list then B<all> volume groups
2653 are activated or deactivated.");
2655 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2656 [InitNone, Always, TestOutput (
2657 [["part_disk"; "/dev/sda"; "mbr"];
2658 ["pvcreate"; "/dev/sda1"];
2659 ["vgcreate"; "VG"; "/dev/sda1"];
2660 ["lvcreate"; "LV"; "VG"; "10"];
2661 ["mkfs"; "ext2"; "/dev/VG/LV"];
2662 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2663 ["write"; "/new"; "test content"];
2665 ["lvresize"; "/dev/VG/LV"; "20"];
2666 ["e2fsck_f"; "/dev/VG/LV"];
2667 ["resize2fs"; "/dev/VG/LV"];
2668 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2669 ["cat"; "/new"]], "test content");
2670 InitNone, Always, TestRun (
2671 (* Make an LV smaller to test RHBZ#587484. *)
2672 [["part_disk"; "/dev/sda"; "mbr"];
2673 ["pvcreate"; "/dev/sda1"];
2674 ["vgcreate"; "VG"; "/dev/sda1"];
2675 ["lvcreate"; "LV"; "VG"; "20"];
2676 ["lvresize"; "/dev/VG/LV"; "10"]])],
2677 "resize an LVM logical volume",
2679 This resizes (expands or shrinks) an existing LVM logical
2680 volume to C<mbytes>. When reducing, data in the reduced part
2683 ("resize2fs", (RErr, [Device "device"]), 106, [],
2684 [], (* lvresize tests this *)
2685 "resize an ext2, ext3 or ext4 filesystem",
2687 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2688 the underlying device.
2690 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2691 on the C<device> before calling this command. For unknown reasons
2692 C<resize2fs> sometimes gives an error about this and sometimes not.
2693 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2694 calling this function.");
2696 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2697 [InitBasicFS, Always, TestOutputList (
2698 [["find"; "/"]], ["lost+found"]);
2699 InitBasicFS, Always, TestOutputList (
2703 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2704 InitBasicFS, Always, TestOutputList (
2705 [["mkdir_p"; "/a/b/c"];
2706 ["touch"; "/a/b/c/d"];
2707 ["find"; "/a/b/"]], ["c"; "c/d"])],
2708 "find all files and directories",
2710 This command lists out all files and directories, recursively,
2711 starting at C<directory>. It is essentially equivalent to
2712 running the shell command C<find directory -print> but some
2713 post-processing happens on the output, described below.
2715 This returns a list of strings I<without any prefix>. Thus
2716 if the directory structure was:
2722 then the returned list from C<guestfs_find> C</tmp> would be
2730 If C<directory> is not a directory, then this command returns
2733 The returned list is sorted.
2735 See also C<guestfs_find0>.");
2737 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2738 [], (* lvresize tests this *)
2739 "check an ext2/ext3 filesystem",
2741 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2742 filesystem checker on C<device>, noninteractively (C<-p>),
2743 even if the filesystem appears to be clean (C<-f>).
2745 This command is only needed because of C<guestfs_resize2fs>
2746 (q.v.). Normally you should use C<guestfs_fsck>.");
2748 ("sleep", (RErr, [Int "secs"]), 109, [],
2749 [InitNone, Always, TestRun (
2751 "sleep for some seconds",
2753 Sleep for C<secs> seconds.");
2755 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2756 [InitNone, Always, TestOutputInt (
2757 [["part_disk"; "/dev/sda"; "mbr"];
2758 ["mkfs"; "ntfs"; "/dev/sda1"];
2759 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2760 InitNone, Always, TestOutputInt (
2761 [["part_disk"; "/dev/sda"; "mbr"];
2762 ["mkfs"; "ext2"; "/dev/sda1"];
2763 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2764 "probe NTFS volume",
2766 This command runs the L<ntfs-3g.probe(8)> command which probes
2767 an NTFS C<device> for mountability. (Not all NTFS volumes can
2768 be mounted read-write, and some cannot be mounted at all).
2770 C<rw> is a boolean flag. Set it to true if you want to test
2771 if the volume can be mounted read-write. Set it to false if
2772 you want to test if the volume can be mounted read-only.
2774 The return value is an integer which C<0> if the operation
2775 would succeed, or some non-zero value documented in the
2776 L<ntfs-3g.probe(8)> manual page.");
2778 ("sh", (RString "output", [String "command"]), 111, [],
2779 [], (* XXX needs tests *)
2780 "run a command via the shell",
2782 This call runs a command from the guest filesystem via the
2785 This is like C<guestfs_command>, but passes the command to:
2787 /bin/sh -c \"command\"
2789 Depending on the guest's shell, this usually results in
2790 wildcards being expanded, shell expressions being interpolated
2793 All the provisos about C<guestfs_command> apply to this call.");
2795 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2796 [], (* XXX needs tests *)
2797 "run a command via the shell returning lines",
2799 This is the same as C<guestfs_sh>, but splits the result
2800 into a list of lines.
2802 See also: C<guestfs_command_lines>");
2804 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2805 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2806 * code in stubs.c, since all valid glob patterns must start with "/".
2807 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2809 [InitBasicFS, Always, TestOutputList (
2810 [["mkdir_p"; "/a/b/c"];
2811 ["touch"; "/a/b/c/d"];
2812 ["touch"; "/a/b/c/e"];
2813 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2814 InitBasicFS, Always, TestOutputList (
2815 [["mkdir_p"; "/a/b/c"];
2816 ["touch"; "/a/b/c/d"];
2817 ["touch"; "/a/b/c/e"];
2818 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2819 InitBasicFS, Always, TestOutputList (
2820 [["mkdir_p"; "/a/b/c"];
2821 ["touch"; "/a/b/c/d"];
2822 ["touch"; "/a/b/c/e"];
2823 ["glob_expand"; "/a/*/x/*"]], [])],
2824 "expand a wildcard path",
2826 This command searches for all the pathnames matching
2827 C<pattern> according to the wildcard expansion rules
2830 If no paths match, then this returns an empty list
2831 (note: not an error).
2833 It is just a wrapper around the C L<glob(3)> function
2834 with flags C<GLOB_MARK|GLOB_BRACE>.
2835 See that manual page for more details.");
2837 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2838 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2839 [["scrub_device"; "/dev/sdc"]])],
2840 "scrub (securely wipe) a device",
2842 This command writes patterns over C<device> to make data retrieval
2845 It is an interface to the L<scrub(1)> program. See that
2846 manual page for more details.");
2848 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2849 [InitBasicFS, Always, TestRun (
2850 [["write"; "/file"; "content"];
2851 ["scrub_file"; "/file"]])],
2852 "scrub (securely wipe) a file",
2854 This command writes patterns over a file to make data retrieval
2857 The file is I<removed> after scrubbing.
2859 It is an interface to the L<scrub(1)> program. See that
2860 manual page for more details.");
2862 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2863 [], (* XXX needs testing *)
2864 "scrub (securely wipe) free space",
2866 This command creates the directory C<dir> and then fills it
2867 with files until the filesystem is full, and scrubs the files
2868 as for C<guestfs_scrub_file>, and deletes them.
2869 The intention is to scrub any free space on the partition
2872 It is an interface to the L<scrub(1)> program. See that
2873 manual page for more details.");
2875 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2876 [InitBasicFS, Always, TestRun (
2878 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2879 "create a temporary directory",
2881 This command creates a temporary directory. The
2882 C<template> parameter should be a full pathname for the
2883 temporary directory name with the final six characters being
2886 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2887 the second one being suitable for Windows filesystems.
2889 The name of the temporary directory that was created
2892 The temporary directory is created with mode 0700
2893 and is owned by root.
2895 The caller is responsible for deleting the temporary
2896 directory and its contents after use.
2898 See also: L<mkdtemp(3)>");
2900 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2901 [InitISOFS, Always, TestOutputInt (
2902 [["wc_l"; "/10klines"]], 10000);
2903 (* Test for RHBZ#579608, absolute symbolic links. *)
2904 InitISOFS, Always, TestOutputInt (
2905 [["wc_l"; "/abssymlink"]], 10000)],
2906 "count lines in a file",
2908 This command counts the lines in a file, using the
2909 C<wc -l> external command.");
2911 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2912 [InitISOFS, Always, TestOutputInt (
2913 [["wc_w"; "/10klines"]], 10000)],
2914 "count words in a file",
2916 This command counts the words in a file, using the
2917 C<wc -w> external command.");
2919 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2920 [InitISOFS, Always, TestOutputInt (
2921 [["wc_c"; "/100kallspaces"]], 102400)],
2922 "count characters in a file",
2924 This command counts the characters in a file, using the
2925 C<wc -c> external command.");
2927 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2928 [InitISOFS, Always, TestOutputList (
2929 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2930 (* Test for RHBZ#579608, absolute symbolic links. *)
2931 InitISOFS, Always, TestOutputList (
2932 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2933 "return first 10 lines of a file",
2935 This command returns up to the first 10 lines of a file as
2936 a list of strings.");
2938 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2939 [InitISOFS, Always, TestOutputList (
2940 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2941 InitISOFS, Always, TestOutputList (
2942 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2943 InitISOFS, Always, TestOutputList (
2944 [["head_n"; "0"; "/10klines"]], [])],
2945 "return first N lines of a file",
2947 If the parameter C<nrlines> is a positive number, this returns the first
2948 C<nrlines> lines of the file C<path>.
2950 If the parameter C<nrlines> is a negative number, this returns lines
2951 from the file C<path>, excluding the last C<nrlines> lines.
2953 If the parameter C<nrlines> is zero, this returns an empty list.");
2955 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2956 [InitISOFS, Always, TestOutputList (
2957 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2958 "return last 10 lines of a file",
2960 This command returns up to the last 10 lines of a file as
2961 a list of strings.");
2963 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2964 [InitISOFS, Always, TestOutputList (
2965 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2966 InitISOFS, Always, TestOutputList (
2967 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2968 InitISOFS, Always, TestOutputList (
2969 [["tail_n"; "0"; "/10klines"]], [])],
2970 "return last N lines of a file",
2972 If the parameter C<nrlines> is a positive number, this returns the last
2973 C<nrlines> lines of the file C<path>.
2975 If the parameter C<nrlines> is a negative number, this returns lines
2976 from the file C<path>, starting with the C<-nrlines>th line.
2978 If the parameter C<nrlines> is zero, this returns an empty list.");
2980 ("df", (RString "output", []), 125, [],
2981 [], (* XXX Tricky to test because it depends on the exact format
2982 * of the 'df' command and other imponderables.
2984 "report file system disk space usage",
2986 This command runs the C<df> command to report disk space used.
2988 This command is mostly useful for interactive sessions. It
2989 is I<not> intended that you try to parse the output string.
2990 Use C<statvfs> from programs.");
2992 ("df_h", (RString "output", []), 126, [],
2993 [], (* XXX Tricky to test because it depends on the exact format
2994 * of the 'df' command and other imponderables.
2996 "report file system disk space usage (human readable)",
2998 This command runs the C<df -h> command to report disk space used
2999 in human-readable format.
3001 This command is mostly useful for interactive sessions. It
3002 is I<not> intended that you try to parse the output string.
3003 Use C<statvfs> from programs.");
3005 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
3006 [InitISOFS, Always, TestOutputInt (
3007 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3008 "estimate file space usage",
3010 This command runs the C<du -s> command to estimate file space
3013 C<path> can be a file or a directory. If C<path> is a directory
3014 then the estimate includes the contents of the directory and all
3015 subdirectories (recursively).
3017 The result is the estimated size in I<kilobytes>
3018 (ie. units of 1024 bytes).");
3020 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
3021 [InitISOFS, Always, TestOutputList (
3022 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3023 "list files in an initrd",
3025 This command lists out files contained in an initrd.
3027 The files are listed without any initial C</> character. The
3028 files are listed in the order they appear (not necessarily
3029 alphabetical). Directory names are listed as separate items.
3031 Old Linux kernels (2.4 and earlier) used a compressed ext2
3032 filesystem as initrd. We I<only> support the newer initramfs
3033 format (compressed cpio files).");
3035 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
3037 "mount a file using the loop device",
3039 This command lets you mount C<file> (a filesystem image
3040 in a file) on a mount point. It is entirely equivalent to
3041 the command C<mount -o loop file mountpoint>.");
3043 ("mkswap", (RErr, [Device "device"]), 130, [],
3044 [InitEmpty, Always, TestRun (
3045 [["part_disk"; "/dev/sda"; "mbr"];
3046 ["mkswap"; "/dev/sda1"]])],
3047 "create a swap partition",
3049 Create a swap partition on C<device>.");
3051 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3052 [InitEmpty, Always, TestRun (
3053 [["part_disk"; "/dev/sda"; "mbr"];
3054 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3055 "create a swap partition with a label",
3057 Create a swap partition on C<device> with label C<label>.
3059 Note that you cannot attach a swap label to a block device
3060 (eg. C</dev/sda>), just to a partition. This appears to be
3061 a limitation of the kernel or swap tools.");
3063 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3064 (let uuid = uuidgen () in
3065 [InitEmpty, Always, TestRun (
3066 [["part_disk"; "/dev/sda"; "mbr"];
3067 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3068 "create a swap partition with an explicit UUID",
3070 Create a swap partition on C<device> with UUID C<uuid>.");
3072 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3073 [InitBasicFS, Always, TestOutputStruct (
3074 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3075 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3076 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3077 InitBasicFS, Always, TestOutputStruct (
3078 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3079 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3080 "make block, character or FIFO devices",
3082 This call creates block or character special devices, or
3083 named pipes (FIFOs).
3085 The C<mode> parameter should be the mode, using the standard
3086 constants. C<devmajor> and C<devminor> are the
3087 device major and minor numbers, only used when creating block
3088 and character special devices.
3090 Note that, just like L<mknod(2)>, the mode must be bitwise
3091 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3092 just creates a regular file). These constants are
3093 available in the standard Linux header files, or you can use
3094 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3095 which are wrappers around this command which bitwise OR
3096 in the appropriate constant for you.
3098 The mode actually set is affected by the umask.");
3100 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3101 [InitBasicFS, Always, TestOutputStruct (
3102 [["mkfifo"; "0o777"; "/node"];
3103 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3104 "make FIFO (named pipe)",
3106 This call creates a FIFO (named pipe) called C<path> with
3107 mode C<mode>. It is just a convenient wrapper around
3110 The mode actually set is affected by the umask.");
3112 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3113 [InitBasicFS, Always, TestOutputStruct (
3114 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3115 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3116 "make block device node",
3118 This call creates a block device node called C<path> with
3119 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3120 It is just a convenient wrapper around C<guestfs_mknod>.
3122 The mode actually set is affected by the umask.");
3124 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3125 [InitBasicFS, Always, TestOutputStruct (
3126 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3127 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3128 "make char device node",
3130 This call creates a char device node called C<path> with
3131 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3132 It is just a convenient wrapper around C<guestfs_mknod>.
3134 The mode actually set is affected by the umask.");
3136 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3137 [InitEmpty, Always, TestOutputInt (
3138 [["umask"; "0o22"]], 0o22)],
3139 "set file mode creation mask (umask)",
3141 This function sets the mask used for creating new files and
3142 device nodes to C<mask & 0777>.
3144 Typical umask values would be C<022> which creates new files
3145 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3146 C<002> which creates new files with permissions like
3147 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3149 The default umask is C<022>. This is important because it
3150 means that directories and device nodes will be created with
3151 C<0644> or C<0755> mode even if you specify C<0777>.
3153 See also C<guestfs_get_umask>,
3154 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3156 This call returns the previous umask.");
3158 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3160 "read directories entries",
3162 This returns the list of directory entries in directory C<dir>.
3164 All entries in the directory are returned, including C<.> and
3165 C<..>. The entries are I<not> sorted, but returned in the same
3166 order as the underlying filesystem.
3168 Also this call returns basic file type information about each
3169 file. The C<ftyp> field will contain one of the following characters:
3207 The L<readdir(3)> call returned a C<d_type> field with an
3212 This function is primarily intended for use by programs. To
3213 get a simple list of names, use C<guestfs_ls>. To get a printable
3214 directory for human consumption, use C<guestfs_ll>.");
3216 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3218 "create partitions on a block device",
3220 This is a simplified interface to the C<guestfs_sfdisk>
3221 command, where partition sizes are specified in megabytes
3222 only (rounded to the nearest cylinder) and you don't need
3223 to specify the cyls, heads and sectors parameters which
3224 were rarely if ever used anyway.
3226 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3227 and C<guestfs_part_disk>");
3229 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3231 "determine file type inside a compressed file",
3233 This command runs C<file> after first decompressing C<path>
3236 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3238 Since 1.0.63, use C<guestfs_file> instead which can now
3239 process compressed files.");
3241 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3243 "list extended attributes of a file or directory",
3245 This call lists the extended attributes of the file or directory
3248 At the system call level, this is a combination of the
3249 L<listxattr(2)> and L<getxattr(2)> calls.
3251 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3253 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3255 "list extended attributes of a file or directory",
3257 This is the same as C<guestfs_getxattrs>, but if C<path>
3258 is a symbolic link, then it returns the extended attributes
3259 of the link itself.");
3261 ("setxattr", (RErr, [String "xattr";
3262 String "val"; Int "vallen"; (* will be BufferIn *)
3263 Pathname "path"]), 143, [Optional "linuxxattrs"],
3265 "set extended attribute of a file or directory",
3267 This call sets the extended attribute named C<xattr>
3268 of the file C<path> to the value C<val> (of length C<vallen>).
3269 The value is arbitrary 8 bit data.
3271 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3273 ("lsetxattr", (RErr, [String "xattr";
3274 String "val"; Int "vallen"; (* will be BufferIn *)
3275 Pathname "path"]), 144, [Optional "linuxxattrs"],
3277 "set extended attribute of a file or directory",
3279 This is the same as C<guestfs_setxattr>, but if C<path>
3280 is a symbolic link, then it sets an extended attribute
3281 of the link itself.");
3283 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3285 "remove extended attribute of a file or directory",
3287 This call removes the extended attribute named C<xattr>
3288 of the file C<path>.
3290 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3292 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3294 "remove extended attribute of a file or directory",
3296 This is the same as C<guestfs_removexattr>, but if C<path>
3297 is a symbolic link, then it removes an extended attribute
3298 of the link itself.");
3300 ("mountpoints", (RHashtable "mps", []), 147, [],
3304 This call is similar to C<guestfs_mounts>. That call returns
3305 a list of devices. This one returns a hash table (map) of
3306 device name to directory where the device is mounted.");
3308 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3309 (* This is a special case: while you would expect a parameter
3310 * of type "Pathname", that doesn't work, because it implies
3311 * NEED_ROOT in the generated calling code in stubs.c, and
3312 * this function cannot use NEED_ROOT.
3315 "create a mountpoint",
3317 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3318 specialized calls that can be used to create extra mountpoints
3319 before mounting the first filesystem.
3321 These calls are I<only> necessary in some very limited circumstances,
3322 mainly the case where you want to mount a mix of unrelated and/or
3323 read-only filesystems together.
3325 For example, live CDs often contain a \"Russian doll\" nest of
3326 filesystems, an ISO outer layer, with a squashfs image inside, with
3327 an ext2/3 image inside that. You can unpack this as follows
3330 add-ro Fedora-11-i686-Live.iso
3333 mkmountpoint /squash
3336 mount-loop /cd/LiveOS/squashfs.img /squash
3337 mount-loop /squash/LiveOS/ext3fs.img /ext3
3339 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3341 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3343 "remove a mountpoint",
3345 This calls removes a mountpoint that was previously created
3346 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3347 for full details.");
3349 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3350 [InitISOFS, Always, TestOutputBuffer (
3351 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3352 (* Test various near large, large and too large files (RHBZ#589039). *)
3353 InitBasicFS, Always, TestLastFail (
3355 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3356 ["read_file"; "/a"]]);
3357 InitBasicFS, Always, TestLastFail (
3359 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3360 ["read_file"; "/a"]]);
3361 InitBasicFS, Always, TestLastFail (
3363 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3364 ["read_file"; "/a"]])],
3367 This calls returns the contents of the file C<path> as a
3370 Unlike C<guestfs_cat>, this function can correctly
3371 handle files that contain embedded ASCII NUL characters.
3372 However unlike C<guestfs_download>, this function is limited
3373 in the total size of file that can be handled.");
3375 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3376 [InitISOFS, Always, TestOutputList (
3377 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3378 InitISOFS, Always, TestOutputList (
3379 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3380 (* Test for RHBZ#579608, absolute symbolic links. *)
3381 InitISOFS, Always, TestOutputList (
3382 [["grep"; "nomatch"; "/abssymlink"]], [])],
3383 "return lines matching a pattern",
3385 This calls the external C<grep> program and returns the
3388 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3389 [InitISOFS, Always, TestOutputList (
3390 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3391 "return lines matching a pattern",
3393 This calls the external C<egrep> program and returns the
3396 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3397 [InitISOFS, Always, TestOutputList (
3398 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3399 "return lines matching a pattern",
3401 This calls the external C<fgrep> program and returns the
3404 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3405 [InitISOFS, Always, TestOutputList (
3406 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3407 "return lines matching a pattern",
3409 This calls the external C<grep -i> program and returns the
3412 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3413 [InitISOFS, Always, TestOutputList (
3414 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3415 "return lines matching a pattern",
3417 This calls the external C<egrep -i> program and returns the
3420 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3421 [InitISOFS, Always, TestOutputList (
3422 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3423 "return lines matching a pattern",
3425 This calls the external C<fgrep -i> program and returns the
3428 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3429 [InitISOFS, Always, TestOutputList (
3430 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3431 "return lines matching a pattern",
3433 This calls the external C<zgrep> program and returns the
3436 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3437 [InitISOFS, Always, TestOutputList (
3438 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3439 "return lines matching a pattern",
3441 This calls the external C<zegrep> program and returns the
3444 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3445 [InitISOFS, Always, TestOutputList (
3446 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3447 "return lines matching a pattern",
3449 This calls the external C<zfgrep> program and returns the
3452 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3453 [InitISOFS, Always, TestOutputList (
3454 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3455 "return lines matching a pattern",
3457 This calls the external C<zgrep -i> program and returns the
3460 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3461 [InitISOFS, Always, TestOutputList (
3462 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3463 "return lines matching a pattern",
3465 This calls the external C<zegrep -i> program and returns the
3468 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3469 [InitISOFS, Always, TestOutputList (
3470 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3471 "return lines matching a pattern",
3473 This calls the external C<zfgrep -i> program and returns the
3476 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3477 [InitISOFS, Always, TestOutput (
3478 [["realpath"; "/../directory"]], "/directory")],
3479 "canonicalized absolute pathname",
3481 Return the canonicalized absolute pathname of C<path>. The
3482 returned path has no C<.>, C<..> or symbolic link path elements.");
3484 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3485 [InitBasicFS, Always, TestOutputStruct (
3488 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3489 "create a hard link",
3491 This command creates a hard link using the C<ln> command.");
3493 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3494 [InitBasicFS, Always, TestOutputStruct (
3497 ["ln_f"; "/a"; "/b"];
3498 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3499 "create a hard link",
3501 This command creates a hard link using the C<ln -f> command.
3502 The C<-f> option removes the link (C<linkname>) if it exists already.");
3504 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3505 [InitBasicFS, Always, TestOutputStruct (
3507 ["ln_s"; "a"; "/b"];
3508 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3509 "create a symbolic link",
3511 This command creates a symbolic link using the C<ln -s> command.");
3513 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3514 [InitBasicFS, Always, TestOutput (
3515 [["mkdir_p"; "/a/b"];
3516 ["touch"; "/a/b/c"];
3517 ["ln_sf"; "../d"; "/a/b/c"];
3518 ["readlink"; "/a/b/c"]], "../d")],
3519 "create a symbolic link",
3521 This command creates a symbolic link using the C<ln -sf> command,
3522 The C<-f> option removes the link (C<linkname>) if it exists already.");
3524 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3525 [] (* XXX tested above *),
3526 "read the target of a symbolic link",
3528 This command reads the target of a symbolic link.");
3530 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3531 [InitBasicFS, Always, TestOutputStruct (
3532 [["fallocate"; "/a"; "1000000"];
3533 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3534 "preallocate a file in the guest filesystem",
3536 This command preallocates a file (containing zero bytes) named
3537 C<path> of size C<len> bytes. If the file exists already, it
3540 Do not confuse this with the guestfish-specific
3541 C<alloc> command which allocates a file in the host and
3542 attaches it as a device.");
3544 ("swapon_device", (RErr, [Device "device"]), 170, [],
3545 [InitPartition, Always, TestRun (
3546 [["mkswap"; "/dev/sda1"];
3547 ["swapon_device"; "/dev/sda1"];
3548 ["swapoff_device"; "/dev/sda1"]])],
3549 "enable swap on device",
3551 This command enables the libguestfs appliance to use the
3552 swap device or partition named C<device>. The increased
3553 memory is made available for all commands, for example
3554 those run using C<guestfs_command> or C<guestfs_sh>.
3556 Note that you should not swap to existing guest swap
3557 partitions unless you know what you are doing. They may
3558 contain hibernation information, or other information that
3559 the guest doesn't want you to trash. You also risk leaking
3560 information about the host to the guest this way. Instead,
3561 attach a new host device to the guest and swap on that.");
3563 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3564 [], (* XXX tested by swapon_device *)
3565 "disable swap on device",
3567 This command disables the libguestfs appliance swap
3568 device or partition named C<device>.
3569 See C<guestfs_swapon_device>.");
3571 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3572 [InitBasicFS, Always, TestRun (
3573 [["fallocate"; "/swap"; "8388608"];
3574 ["mkswap_file"; "/swap"];
3575 ["swapon_file"; "/swap"];
3576 ["swapoff_file"; "/swap"]])],
3577 "enable swap on file",
3579 This command enables swap to a file.
3580 See C<guestfs_swapon_device> for other notes.");
3582 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3583 [], (* XXX tested by swapon_file *)
3584 "disable swap on file",
3586 This command disables the libguestfs appliance swap on file.");
3588 ("swapon_label", (RErr, [String "label"]), 174, [],
3589 [InitEmpty, Always, TestRun (
3590 [["part_disk"; "/dev/sdb"; "mbr"];
3591 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3592 ["swapon_label"; "swapit"];
3593 ["swapoff_label"; "swapit"];
3594 ["zero"; "/dev/sdb"];
3595 ["blockdev_rereadpt"; "/dev/sdb"]])],
3596 "enable swap on labeled swap partition",
3598 This command enables swap to a labeled swap partition.
3599 See C<guestfs_swapon_device> for other notes.");
3601 ("swapoff_label", (RErr, [String "label"]), 175, [],
3602 [], (* XXX tested by swapon_label *)
3603 "disable swap on labeled swap partition",
3605 This command disables the libguestfs appliance swap on
3606 labeled swap partition.");
3608 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3609 (let uuid = uuidgen () in
3610 [InitEmpty, Always, TestRun (
3611 [["mkswap_U"; uuid; "/dev/sdb"];
3612 ["swapon_uuid"; uuid];
3613 ["swapoff_uuid"; uuid]])]),
3614 "enable swap on swap partition by UUID",
3616 This command enables swap to a swap partition with the given UUID.
3617 See C<guestfs_swapon_device> for other notes.");
3619 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3620 [], (* XXX tested by swapon_uuid *)
3621 "disable swap on swap partition by UUID",
3623 This command disables the libguestfs appliance swap partition
3624 with the given UUID.");
3626 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3627 [InitBasicFS, Always, TestRun (
3628 [["fallocate"; "/swap"; "8388608"];
3629 ["mkswap_file"; "/swap"]])],
3630 "create a swap file",
3634 This command just writes a swap file signature to an existing
3635 file. To create the file itself, use something like C<guestfs_fallocate>.");
3637 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3638 [InitISOFS, Always, TestRun (
3639 [["inotify_init"; "0"]])],
3640 "create an inotify handle",
3642 This command creates a new inotify handle.
3643 The inotify subsystem can be used to notify events which happen to
3644 objects in the guest filesystem.
3646 C<maxevents> is the maximum number of events which will be
3647 queued up between calls to C<guestfs_inotify_read> or
3648 C<guestfs_inotify_files>.
3649 If this is passed as C<0>, then the kernel (or previously set)
3650 default is used. For Linux 2.6.29 the default was 16384 events.
3651 Beyond this limit, the kernel throws away events, but records
3652 the fact that it threw them away by setting a flag
3653 C<IN_Q_OVERFLOW> in the returned structure list (see
3654 C<guestfs_inotify_read>).
3656 Before any events are generated, you have to add some
3657 watches to the internal watch list. See:
3658 C<guestfs_inotify_add_watch>,
3659 C<guestfs_inotify_rm_watch> and
3660 C<guestfs_inotify_watch_all>.
3662 Queued up events should be read periodically by calling
3663 C<guestfs_inotify_read>
3664 (or C<guestfs_inotify_files> which is just a helpful
3665 wrapper around C<guestfs_inotify_read>). If you don't
3666 read the events out often enough then you risk the internal
3669 The handle should be closed after use by calling
3670 C<guestfs_inotify_close>. This also removes any
3671 watches automatically.
3673 See also L<inotify(7)> for an overview of the inotify interface
3674 as exposed by the Linux kernel, which is roughly what we expose
3675 via libguestfs. Note that there is one global inotify handle
3676 per libguestfs instance.");
3678 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3679 [InitBasicFS, Always, TestOutputList (
3680 [["inotify_init"; "0"];
3681 ["inotify_add_watch"; "/"; "1073741823"];
3684 ["inotify_files"]], ["a"; "b"])],
3685 "add an inotify watch",
3687 Watch C<path> for the events listed in C<mask>.
3689 Note that if C<path> is a directory then events within that
3690 directory are watched, but this does I<not> happen recursively
3691 (in subdirectories).
3693 Note for non-C or non-Linux callers: the inotify events are
3694 defined by the Linux kernel ABI and are listed in
3695 C</usr/include/sys/inotify.h>.");
3697 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3699 "remove an inotify watch",
3701 Remove a previously defined inotify watch.
3702 See C<guestfs_inotify_add_watch>.");
3704 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3706 "return list of inotify events",
3708 Return the complete queue of events that have happened
3709 since the previous read call.
3711 If no events have happened, this returns an empty list.
3713 I<Note>: In order to make sure that all events have been
3714 read, you must call this function repeatedly until it
3715 returns an empty list. The reason is that the call will
3716 read events up to the maximum appliance-to-host message
3717 size and leave remaining events in the queue.");
3719 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3721 "return list of watched files that had events",
3723 This function is a helpful wrapper around C<guestfs_inotify_read>
3724 which just returns a list of pathnames of objects that were
3725 touched. The returned pathnames are sorted and deduplicated.");
3727 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3729 "close the inotify handle",
3731 This closes the inotify handle which was previously
3732 opened by inotify_init. It removes all watches, throws
3733 away any pending events, and deallocates all resources.");
3735 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3737 "set SELinux security context",
3739 This sets the SELinux security context of the daemon
3740 to the string C<context>.
3742 See the documentation about SELINUX in L<guestfs(3)>.");
3744 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3746 "get SELinux security context",
3748 This gets the SELinux security context of the daemon.
3750 See the documentation about SELINUX in L<guestfs(3)>,
3751 and C<guestfs_setcon>");
3753 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3754 [InitEmpty, Always, TestOutput (
3755 [["part_disk"; "/dev/sda"; "mbr"];
3756 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3757 ["mount_options"; ""; "/dev/sda1"; "/"];
3758 ["write"; "/new"; "new file contents"];
3759 ["cat"; "/new"]], "new file contents");
3760 InitEmpty, Always, TestRun (
3761 [["part_disk"; "/dev/sda"; "mbr"];
3762 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3763 InitEmpty, Always, TestLastFail (
3764 [["part_disk"; "/dev/sda"; "mbr"];
3765 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3766 InitEmpty, Always, TestLastFail (
3767 [["part_disk"; "/dev/sda"; "mbr"];
3768 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3769 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3770 [["part_disk"; "/dev/sda"; "mbr"];
3771 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3772 "make a filesystem with block size",
3774 This call is similar to C<guestfs_mkfs>, but it allows you to
3775 control the block size of the resulting filesystem. Supported
3776 block sizes depend on the filesystem type, but typically they
3777 are C<1024>, C<2048> or C<4096> only.
3779 For VFAT and NTFS the C<blocksize> parameter is treated as
3780 the requested cluster size.");
3782 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3783 [InitEmpty, Always, TestOutput (
3784 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3785 ["mke2journal"; "4096"; "/dev/sda1"];
3786 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3787 ["mount_options"; ""; "/dev/sda2"; "/"];
3788 ["write"; "/new"; "new file contents"];
3789 ["cat"; "/new"]], "new file contents")],
3790 "make ext2/3/4 external journal",
3792 This creates an ext2 external journal on C<device>. It is equivalent
3795 mke2fs -O journal_dev -b blocksize device");
3797 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3798 [InitEmpty, Always, TestOutput (
3799 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3800 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3801 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3802 ["mount_options"; ""; "/dev/sda2"; "/"];
3803 ["write"; "/new"; "new file contents"];
3804 ["cat"; "/new"]], "new file contents")],
3805 "make ext2/3/4 external journal with label",
3807 This creates an ext2 external journal on C<device> with label C<label>.");
3809 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3810 (let uuid = uuidgen () in
3811 [InitEmpty, Always, TestOutput (
3812 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3813 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3814 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3815 ["mount_options"; ""; "/dev/sda2"; "/"];
3816 ["write"; "/new"; "new file contents"];
3817 ["cat"; "/new"]], "new file contents")]),
3818 "make ext2/3/4 external journal with UUID",
3820 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3822 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3824 "make ext2/3/4 filesystem with external journal",
3826 This creates an ext2/3/4 filesystem on C<device> with
3827 an external journal on C<journal>. It is equivalent
3830 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3832 See also C<guestfs_mke2journal>.");
3834 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3836 "make ext2/3/4 filesystem with external journal",
3838 This creates an ext2/3/4 filesystem on C<device> with
3839 an external journal on the journal labeled C<label>.
3841 See also C<guestfs_mke2journal_L>.");
3843 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3845 "make ext2/3/4 filesystem with external journal",
3847 This creates an ext2/3/4 filesystem on C<device> with
3848 an external journal on the journal with UUID C<uuid>.
3850 See also C<guestfs_mke2journal_U>.");
3852 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3853 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3854 "load a kernel module",
3856 This loads a kernel module in the appliance.
3858 The kernel module must have been whitelisted when libguestfs
3859 was built (see C<appliance/kmod.whitelist.in> in the source).");
3861 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3862 [InitNone, Always, TestOutput (
3863 [["echo_daemon"; "This is a test"]], "This is a test"
3865 "echo arguments back to the client",
3867 This command concatenates the list of C<words> passed with single spaces
3868 between them and returns the resulting string.
3870 You can use this command to test the connection through to the daemon.
3872 See also C<guestfs_ping_daemon>.");
3874 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3875 [], (* There is a regression test for this. *)
3876 "find all files and directories, returning NUL-separated list",
3878 This command lists out all files and directories, recursively,
3879 starting at C<directory>, placing the resulting list in the
3880 external file called C<files>.
3882 This command works the same way as C<guestfs_find> with the
3883 following exceptions:
3889 The resulting list is written to an external file.
3893 Items (filenames) in the result are separated
3894 by C<\\0> characters. See L<find(1)> option I<-print0>.
3898 This command is not limited in the number of names that it
3903 The result list is not sorted.
3907 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3908 [InitISOFS, Always, TestOutput (
3909 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3910 InitISOFS, Always, TestOutput (
3911 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3912 InitISOFS, Always, TestOutput (
3913 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3914 InitISOFS, Always, TestLastFail (
3915 [["case_sensitive_path"; "/Known-1/"]]);
3916 InitBasicFS, Always, TestOutput (
3918 ["mkdir"; "/a/bbb"];
3919 ["touch"; "/a/bbb/c"];
3920 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3921 InitBasicFS, Always, TestOutput (
3923 ["mkdir"; "/a/bbb"];
3924 ["touch"; "/a/bbb/c"];
3925 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3926 InitBasicFS, Always, TestLastFail (
3928 ["mkdir"; "/a/bbb"];
3929 ["touch"; "/a/bbb/c"];
3930 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3931 "return true path on case-insensitive filesystem",
3933 This can be used to resolve case insensitive paths on
3934 a filesystem which is case sensitive. The use case is
3935 to resolve paths which you have read from Windows configuration
3936 files or the Windows Registry, to the true path.
3938 The command handles a peculiarity of the Linux ntfs-3g
3939 filesystem driver (and probably others), which is that although
3940 the underlying filesystem is case-insensitive, the driver
3941 exports the filesystem to Linux as case-sensitive.
3943 One consequence of this is that special directories such
3944 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3945 (or other things) depending on the precise details of how
3946 they were created. In Windows itself this would not be
3949 Bug or feature? You decide:
3950 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3952 This function resolves the true case of each element in the
3953 path and returns the case-sensitive path.
3955 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3956 might return C<\"/WINDOWS/system32\"> (the exact return value
3957 would depend on details of how the directories were originally
3958 created under Windows).
3961 This function does not handle drive names, backslashes etc.
3963 See also C<guestfs_realpath>.");
3965 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3966 [InitBasicFS, Always, TestOutput (
3967 [["vfs_type"; "/dev/sda1"]], "ext2")],
3968 "get the Linux VFS type corresponding to a mounted device",
3970 This command gets the filesystem type corresponding to
3971 the filesystem on C<device>.
3973 For most filesystems, the result is the name of the Linux
3974 VFS module which would be used to mount this filesystem
3975 if you mounted it without specifying the filesystem type.
3976 For example a string such as C<ext3> or C<ntfs>.");
3978 ("truncate", (RErr, [Pathname "path"]), 199, [],
3979 [InitBasicFS, Always, TestOutputStruct (
3980 [["write"; "/test"; "some stuff so size is not zero"];
3981 ["truncate"; "/test"];
3982 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3983 "truncate a file to zero size",
3985 This command truncates C<path> to a zero-length file. The
3986 file must exist already.");
3988 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3989 [InitBasicFS, Always, TestOutputStruct (
3990 [["touch"; "/test"];
3991 ["truncate_size"; "/test"; "1000"];
3992 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3993 "truncate a file to a particular size",
3995 This command truncates C<path> to size C<size> bytes. The file
3998 If the current file size is less than C<size> then
3999 the file is extended to the required size with zero bytes.
4000 This creates a sparse file (ie. disk blocks are not allocated
4001 for the file until you write to it). To create a non-sparse
4002 file of zeroes, use C<guestfs_fallocate64> instead.");
4004 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
4005 [InitBasicFS, Always, TestOutputStruct (
4006 [["touch"; "/test"];
4007 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4008 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4009 "set timestamp of a file with nanosecond precision",
4011 This command sets the timestamps of a file with nanosecond
4014 C<atsecs, atnsecs> are the last access time (atime) in secs and
4015 nanoseconds from the epoch.
4017 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4018 secs and nanoseconds from the epoch.
4020 If the C<*nsecs> field contains the special value C<-1> then
4021 the corresponding timestamp is set to the current time. (The
4022 C<*secs> field is ignored in this case).
4024 If the C<*nsecs> field contains the special value C<-2> then
4025 the corresponding timestamp is left unchanged. (The
4026 C<*secs> field is ignored in this case).");
4028 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
4029 [InitBasicFS, Always, TestOutputStruct (
4030 [["mkdir_mode"; "/test"; "0o111"];
4031 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4032 "create a directory with a particular mode",
4034 This command creates a directory, setting the initial permissions
4035 of the directory to C<mode>.
4037 For common Linux filesystems, the actual mode which is set will
4038 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4039 interpret the mode in other ways.
4041 See also C<guestfs_mkdir>, C<guestfs_umask>");
4043 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
4045 "change file owner and group",
4047 Change the file owner to C<owner> and group to C<group>.
4048 This is like C<guestfs_chown> but if C<path> is a symlink then
4049 the link itself is changed, not the target.
4051 Only numeric uid and gid are supported. If you want to use
4052 names, you will need to locate and parse the password file
4053 yourself (Augeas support makes this relatively easy).");
4055 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
4057 "lstat on multiple files",
4059 This call allows you to perform the C<guestfs_lstat> operation
4060 on multiple files, where all files are in the directory C<path>.
4061 C<names> is the list of files from this directory.
4063 On return you get a list of stat structs, with a one-to-one
4064 correspondence to the C<names> list. If any name did not exist
4065 or could not be lstat'd, then the C<ino> field of that structure
4068 This call is intended for programs that want to efficiently
4069 list a directory contents without making many round-trips.
4070 See also C<guestfs_lxattrlist> for a similarly efficient call
4071 for getting extended attributes. Very long directory listings
4072 might cause the protocol message size to be exceeded, causing
4073 this call to fail. The caller must split up such requests
4074 into smaller groups of names.");
4076 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4078 "lgetxattr on multiple files",
4080 This call allows you to get the extended attributes
4081 of multiple files, where all files are in the directory C<path>.
4082 C<names> is the list of files from this directory.
4084 On return you get a flat list of xattr structs which must be
4085 interpreted sequentially. The first xattr struct always has a zero-length
4086 C<attrname>. C<attrval> in this struct is zero-length
4087 to indicate there was an error doing C<lgetxattr> for this
4088 file, I<or> is a C string which is a decimal number
4089 (the number of following attributes for this file, which could
4090 be C<\"0\">). Then after the first xattr struct are the
4091 zero or more attributes for the first named file.
4092 This repeats for the second and subsequent files.
4094 This call is intended for programs that want to efficiently
4095 list a directory contents without making many round-trips.
4096 See also C<guestfs_lstatlist> for a similarly efficient call
4097 for getting standard stats. Very long directory listings
4098 might cause the protocol message size to be exceeded, causing
4099 this call to fail. The caller must split up such requests
4100 into smaller groups of names.");
4102 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4104 "readlink on multiple files",
4106 This call allows you to do a C<readlink> operation
4107 on multiple files, where all files are in the directory C<path>.
4108 C<names> is the list of files from this directory.
4110 On return you get a list of strings, with a one-to-one
4111 correspondence to the C<names> list. Each string is the
4112 value of the symbolic link.
4114 If the C<readlink(2)> operation fails on any name, then
4115 the corresponding result string is the empty string C<\"\">.
4116 However the whole operation is completed even if there
4117 were C<readlink(2)> errors, and so you can call this
4118 function with names where you don't know if they are
4119 symbolic links already (albeit slightly less efficient).
4121 This call is intended for programs that want to efficiently
4122 list a directory contents without making many round-trips.
4123 Very long directory listings might cause the protocol
4124 message size to be exceeded, causing
4125 this call to fail. The caller must split up such requests
4126 into smaller groups of names.");
4128 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4129 [InitISOFS, Always, TestOutputBuffer (
4130 [["pread"; "/known-4"; "1"; "3"]], "\n");
4131 InitISOFS, Always, TestOutputBuffer (
4132 [["pread"; "/empty"; "0"; "100"]], "")],
4133 "read part of a file",
4135 This command lets you read part of a file. It reads C<count>
4136 bytes of the file, starting at C<offset>, from file C<path>.
4138 This may read fewer bytes than requested. For further details
4139 see the L<pread(2)> system call.
4141 See also C<guestfs_pwrite>.");
4143 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4144 [InitEmpty, Always, TestRun (
4145 [["part_init"; "/dev/sda"; "gpt"]])],
4146 "create an empty partition table",
4148 This creates an empty partition table on C<device> of one of the
4149 partition types listed below. Usually C<parttype> should be
4150 either C<msdos> or C<gpt> (for large disks).
4152 Initially there are no partitions. Following this, you should
4153 call C<guestfs_part_add> for each partition required.
4155 Possible values for C<parttype> are:
4159 =item B<efi> | B<gpt>
4161 Intel EFI / GPT partition table.
4163 This is recommended for >= 2 TB partitions that will be accessed
4164 from Linux and Intel-based Mac OS X. It also has limited backwards
4165 compatibility with the C<mbr> format.
4167 =item B<mbr> | B<msdos>
4169 The standard PC \"Master Boot Record\" (MBR) format used
4170 by MS-DOS and Windows. This partition type will B<only> work
4171 for device sizes up to 2 TB. For large disks we recommend
4176 Other partition table types that may work but are not
4185 =item B<amiga> | B<rdb>
4187 Amiga \"Rigid Disk Block\" format.
4195 DASD, used on IBM mainframes.
4203 Old Mac partition format. Modern Macs use C<gpt>.
4207 NEC PC-98 format, common in Japan apparently.
4215 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4216 [InitEmpty, Always, TestRun (
4217 [["part_init"; "/dev/sda"; "mbr"];
4218 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4219 InitEmpty, Always, TestRun (
4220 [["part_init"; "/dev/sda"; "gpt"];
4221 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4222 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4223 InitEmpty, Always, TestRun (
4224 [["part_init"; "/dev/sda"; "mbr"];
4225 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4226 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4227 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4228 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4229 "add a partition to the device",
4231 This command adds a partition to C<device>. If there is no partition
4232 table on the device, call C<guestfs_part_init> first.
4234 The C<prlogex> parameter is the type of partition. Normally you
4235 should pass C<p> or C<primary> here, but MBR partition tables also
4236 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4239 C<startsect> and C<endsect> are the start and end of the partition
4240 in I<sectors>. C<endsect> may be negative, which means it counts
4241 backwards from the end of the disk (C<-1> is the last sector).
4243 Creating a partition which covers the whole disk is not so easy.
4244 Use C<guestfs_part_disk> to do that.");
4246 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4247 [InitEmpty, Always, TestRun (
4248 [["part_disk"; "/dev/sda"; "mbr"]]);
4249 InitEmpty, Always, TestRun (
4250 [["part_disk"; "/dev/sda"; "gpt"]])],
4251 "partition whole disk with a single primary partition",
4253 This command is simply a combination of C<guestfs_part_init>
4254 followed by C<guestfs_part_add> to create a single primary partition
4255 covering the whole disk.
4257 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4258 but other possible values are described in C<guestfs_part_init>.");
4260 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4261 [InitEmpty, Always, TestRun (
4262 [["part_disk"; "/dev/sda"; "mbr"];
4263 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4264 "make a partition bootable",
4266 This sets the bootable flag on partition numbered C<partnum> on
4267 device C<device>. Note that partitions are numbered from 1.
4269 The bootable flag is used by some operating systems (notably
4270 Windows) to determine which partition to boot from. It is by
4271 no means universally recognized.");
4273 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4274 [InitEmpty, Always, TestRun (
4275 [["part_disk"; "/dev/sda"; "gpt"];
4276 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4277 "set partition name",
4279 This sets the partition name on partition numbered C<partnum> on
4280 device C<device>. Note that partitions are numbered from 1.
4282 The partition name can only be set on certain types of partition
4283 table. This works on C<gpt> but not on C<mbr> partitions.");
4285 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4286 [], (* XXX Add a regression test for this. *)
4287 "list partitions on a device",
4289 This command parses the partition table on C<device> and
4290 returns the list of partitions found.
4292 The fields in the returned structure are:
4298 Partition number, counting from 1.
4302 Start of the partition I<in bytes>. To get sectors you have to
4303 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4307 End of the partition in bytes.
4311 Size of the partition in bytes.
4315 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4316 [InitEmpty, Always, TestOutput (
4317 [["part_disk"; "/dev/sda"; "gpt"];
4318 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4319 "get the partition table type",
4321 This command examines the partition table on C<device> and
4322 returns the partition table type (format) being used.
4324 Common return values include: C<msdos> (a DOS/Windows style MBR
4325 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4326 values are possible, although unusual. See C<guestfs_part_init>
4329 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4330 [InitBasicFS, Always, TestOutputBuffer (
4331 [["fill"; "0x63"; "10"; "/test"];
4332 ["read_file"; "/test"]], "cccccccccc")],
4333 "fill a file with octets",
4335 This command creates a new file called C<path>. The initial
4336 content of the file is C<len> octets of C<c>, where C<c>
4337 must be a number in the range C<[0..255]>.
4339 To fill a file with zero bytes (sparsely), it is
4340 much more efficient to use C<guestfs_truncate_size>.
4341 To create a file with a pattern of repeating bytes
4342 use C<guestfs_fill_pattern>.");
4344 ("available", (RErr, [StringList "groups"]), 216, [],
4345 [InitNone, Always, TestRun [["available"; ""]]],
4346 "test availability of some parts of the API",
4348 This command is used to check the availability of some
4349 groups of functionality in the appliance, which not all builds of
4350 the libguestfs appliance will be able to provide.
4352 The libguestfs groups, and the functions that those
4353 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4354 You can also fetch this list at runtime by calling
4355 C<guestfs_available_all_groups>.
4357 The argument C<groups> is a list of group names, eg:
4358 C<[\"inotify\", \"augeas\"]> would check for the availability of
4359 the Linux inotify functions and Augeas (configuration file
4362 The command returns no error if I<all> requested groups are available.
4364 It fails with an error if one or more of the requested
4365 groups is unavailable in the appliance.
4367 If an unknown group name is included in the
4368 list of groups then an error is always returned.
4376 You must call C<guestfs_launch> before calling this function.
4378 The reason is because we don't know what groups are
4379 supported by the appliance/daemon until it is running and can
4384 If a group of functions is available, this does not necessarily
4385 mean that they will work. You still have to check for errors
4386 when calling individual API functions even if they are
4391 It is usually the job of distro packagers to build
4392 complete functionality into the libguestfs appliance.
4393 Upstream libguestfs, if built from source with all
4394 requirements satisfied, will support everything.
4398 This call was added in version C<1.0.80>. In previous
4399 versions of libguestfs all you could do would be to speculatively
4400 execute a command to find out if the daemon implemented it.
4401 See also C<guestfs_version>.
4405 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4406 [InitBasicFS, Always, TestOutputBuffer (
4407 [["write"; "/src"; "hello, world"];
4408 ["dd"; "/src"; "/dest"];
4409 ["read_file"; "/dest"]], "hello, world")],
4410 "copy from source to destination using dd",
4412 This command copies from one source device or file C<src>
4413 to another destination device or file C<dest>. Normally you
4414 would use this to copy to or from a device or partition, for
4415 example to duplicate a filesystem.
4417 If the destination is a device, it must be as large or larger
4418 than the source file or device, otherwise the copy will fail.
4419 This command cannot do partial copies (see C<guestfs_copy_size>).");
4421 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4422 [InitBasicFS, Always, TestOutputInt (
4423 [["write"; "/file"; "hello, world"];
4424 ["filesize"; "/file"]], 12)],
4425 "return the size of the file in bytes",
4427 This command returns the size of C<file> in bytes.
4429 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4430 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4431 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4433 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4434 [InitBasicFSonLVM, Always, TestOutputList (
4435 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4436 ["lvs"]], ["/dev/VG/LV2"])],
4437 "rename an LVM logical volume",
4439 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4441 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4442 [InitBasicFSonLVM, Always, TestOutputList (
4444 ["vg_activate"; "false"; "VG"];
4445 ["vgrename"; "VG"; "VG2"];
4446 ["vg_activate"; "true"; "VG2"];
4447 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4448 ["vgs"]], ["VG2"])],
4449 "rename an LVM volume group",
4451 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4453 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4454 [InitISOFS, Always, TestOutputBuffer (
4455 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4456 "list the contents of a single file in an initrd",
4458 This command unpacks the file C<filename> from the initrd file
4459 called C<initrdpath>. The filename must be given I<without> the
4460 initial C</> character.
4462 For example, in guestfish you could use the following command
4463 to examine the boot script (usually called C</init>)
4464 contained in a Linux initrd or initramfs image:
4466 initrd-cat /boot/initrd-<version>.img init
4468 See also C<guestfs_initrd_list>.");
4470 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4472 "get the UUID of a physical volume",
4474 This command returns the UUID of the LVM PV C<device>.");
4476 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4478 "get the UUID of a volume group",
4480 This command returns the UUID of the LVM VG named C<vgname>.");
4482 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4484 "get the UUID of a logical volume",
4486 This command returns the UUID of the LVM LV C<device>.");
4488 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4490 "get the PV UUIDs containing the volume group",
4492 Given a VG called C<vgname>, this returns the UUIDs of all
4493 the physical volumes that this volume group resides on.
4495 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4496 calls to associate physical volumes and volume groups.
4498 See also C<guestfs_vglvuuids>.");
4500 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4502 "get the LV UUIDs of all LVs in the volume group",
4504 Given a VG called C<vgname>, this returns the UUIDs of all
4505 the logical volumes created in this volume group.
4507 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4508 calls to associate logical volumes and volume groups.
4510 See also C<guestfs_vgpvuuids>.");
4512 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4513 [InitBasicFS, Always, TestOutputBuffer (
4514 [["write"; "/src"; "hello, world"];
4515 ["copy_size"; "/src"; "/dest"; "5"];
4516 ["read_file"; "/dest"]], "hello")],
4517 "copy size bytes from source to destination using dd",
4519 This command copies exactly C<size> bytes from one source device
4520 or file C<src> to another destination device or file C<dest>.
4522 Note this will fail if the source is too short or if the destination
4523 is not large enough.");
4525 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4526 [InitBasicFSonLVM, Always, TestRun (
4527 [["zero_device"; "/dev/VG/LV"]])],
4528 "write zeroes to an entire device",
4530 This command writes zeroes over the entire C<device>. Compare
4531 with C<guestfs_zero> which just zeroes the first few blocks of
4534 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [Optional "xz"],
4535 [InitBasicFS, Always, TestOutput (
4536 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4537 ["cat"; "/hello"]], "hello\n")],
4538 "unpack compressed tarball to directory",
4540 This command uploads and unpacks local file C<tarball> (an
4541 I<xz compressed> tar file) into C<directory>.");
4543 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [Optional "xz"],
4545 "pack directory into compressed tarball",
4547 This command packs the contents of C<directory> and downloads
4548 it to local file C<tarball> (as an xz compressed tar archive).");
4550 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4552 "resize an NTFS filesystem",
4554 This command resizes an NTFS filesystem, expanding or
4555 shrinking it to the size of the underlying device.
4556 See also L<ntfsresize(8)>.");
4558 ("vgscan", (RErr, []), 232, [],
4559 [InitEmpty, Always, TestRun (
4561 "rescan for LVM physical volumes, volume groups and logical volumes",
4563 This rescans all block devices and rebuilds the list of LVM
4564 physical volumes, volume groups and logical volumes.");
4566 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4567 [InitEmpty, Always, TestRun (
4568 [["part_init"; "/dev/sda"; "mbr"];
4569 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4570 ["part_del"; "/dev/sda"; "1"]])],
4571 "delete a partition",
4573 This command deletes the partition numbered C<partnum> on C<device>.
4575 Note that in the case of MBR partitioning, deleting an
4576 extended partition also deletes any logical partitions
4579 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4580 [InitEmpty, Always, TestOutputTrue (
4581 [["part_init"; "/dev/sda"; "mbr"];
4582 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4583 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4584 ["part_get_bootable"; "/dev/sda"; "1"]])],
4585 "return true if a partition is bootable",
4587 This command returns true if the partition C<partnum> on
4588 C<device> has the bootable flag set.
4590 See also C<guestfs_part_set_bootable>.");
4592 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4593 [InitEmpty, Always, TestOutputInt (
4594 [["part_init"; "/dev/sda"; "mbr"];
4595 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4596 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4597 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4598 "get the MBR type byte (ID byte) from a partition",
4600 Returns the MBR type byte (also known as the ID byte) from
4601 the numbered partition C<partnum>.
4603 Note that only MBR (old DOS-style) partitions have type bytes.
4604 You will get undefined results for other partition table
4605 types (see C<guestfs_part_get_parttype>).");
4607 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4608 [], (* tested by part_get_mbr_id *)
4609 "set the MBR type byte (ID byte) of a partition",
4611 Sets the MBR type byte (also known as the ID byte) of
4612 the numbered partition C<partnum> to C<idbyte>. Note
4613 that the type bytes quoted in most documentation are
4614 in fact hexadecimal numbers, but usually documented
4615 without any leading \"0x\" which might be confusing.
4617 Note that only MBR (old DOS-style) partitions have type bytes.
4618 You will get undefined results for other partition table
4619 types (see C<guestfs_part_get_parttype>).");
4621 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4622 [InitISOFS, Always, TestOutput (
4623 [["checksum_device"; "md5"; "/dev/sdd"]],
4624 (Digest.to_hex (Digest.file "images/test.iso")))],
4625 "compute MD5, SHAx or CRC checksum of the contents of a device",
4627 This call computes the MD5, SHAx or CRC checksum of the
4628 contents of the device named C<device>. For the types of
4629 checksums supported see the C<guestfs_checksum> command.");
4631 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4632 [InitNone, Always, TestRun (
4633 [["part_disk"; "/dev/sda"; "mbr"];
4634 ["pvcreate"; "/dev/sda1"];
4635 ["vgcreate"; "VG"; "/dev/sda1"];
4636 ["lvcreate"; "LV"; "VG"; "10"];
4637 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4638 "expand an LV to fill free space",
4640 This expands an existing logical volume C<lv> so that it fills
4641 C<pc>% of the remaining free space in the volume group. Commonly
4642 you would call this with pc = 100 which expands the logical volume
4643 as much as possible, using all remaining free space in the volume
4646 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4647 [], (* XXX Augeas code needs tests. *)
4648 "clear Augeas path",
4650 Set the value associated with C<path> to C<NULL>. This
4651 is the same as the L<augtool(1)> C<clear> command.");
4653 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
4654 [InitEmpty, Always, TestOutputInt (
4655 [["get_umask"]], 0o22)],
4656 "get the current umask",
4658 Return the current umask. By default the umask is C<022>
4659 unless it has been set by calling C<guestfs_umask>.");
4661 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
4663 "upload a file to the appliance (internal use only)",
4665 The C<guestfs_debug_upload> command uploads a file to
4666 the libguestfs appliance.
4668 There is no comprehensive help for this command. You have
4669 to look at the file C<daemon/debug.c> in the libguestfs source
4670 to find out what it is for.");
4672 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
4673 [InitBasicFS, Always, TestOutput (
4674 [["base64_in"; "../images/hello.b64"; "/hello"];
4675 ["cat"; "/hello"]], "hello\n")],
4676 "upload base64-encoded data to file",
4678 This command uploads base64-encoded data from C<base64file>
4681 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
4683 "download file and encode as base64",
4685 This command downloads the contents of C<filename>, writing
4686 it out to local file C<base64file> encoded as base64.");
4688 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
4690 "compute MD5, SHAx or CRC checksum of files in a directory",
4692 This command computes the checksums of all regular files in
4693 C<directory> and then emits a list of those checksums to
4694 the local output file C<sumsfile>.
4696 This can be used for verifying the integrity of a virtual
4697 machine. However to be properly secure you should pay
4698 attention to the output of the checksum command (it uses
4699 the ones from GNU coreutils). In particular when the
4700 filename is not printable, coreutils uses a special
4701 backslash syntax. For more information, see the GNU
4702 coreutils info file.");
4704 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
4705 [InitBasicFS, Always, TestOutputBuffer (
4706 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4707 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4708 "fill a file with a repeating pattern of bytes",
4710 This function is like C<guestfs_fill> except that it creates
4711 a new file of length C<len> containing the repeating pattern
4712 of bytes in C<pattern>. The pattern is truncated if necessary
4713 to ensure the length of the file is exactly C<len> bytes.");
4715 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
4716 [InitBasicFS, Always, TestOutput (
4717 [["write"; "/new"; "new file contents"];
4718 ["cat"; "/new"]], "new file contents");
4719 InitBasicFS, Always, TestOutput (
4720 [["write"; "/new"; "\nnew file contents\n"];
4721 ["cat"; "/new"]], "\nnew file contents\n");
4722 InitBasicFS, Always, TestOutput (
4723 [["write"; "/new"; "\n\n"];
4724 ["cat"; "/new"]], "\n\n");
4725 InitBasicFS, Always, TestOutput (
4726 [["write"; "/new"; ""];
4727 ["cat"; "/new"]], "");
4728 InitBasicFS, Always, TestOutput (
4729 [["write"; "/new"; "\n\n\n"];
4730 ["cat"; "/new"]], "\n\n\n");
4731 InitBasicFS, Always, TestOutput (
4732 [["write"; "/new"; "\n"];
4733 ["cat"; "/new"]], "\n")],
4734 "create a new file",
4736 This call creates a file called C<path>. The content of the
4737 file is the string C<content> (which can contain any 8 bit data).");
4739 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
4740 [InitBasicFS, Always, TestOutput (
4741 [["write"; "/new"; "new file contents"];
4742 ["pwrite"; "/new"; "data"; "4"];
4743 ["cat"; "/new"]], "new data contents");
4744 InitBasicFS, Always, TestOutput (
4745 [["write"; "/new"; "new file contents"];
4746 ["pwrite"; "/new"; "is extended"; "9"];
4747 ["cat"; "/new"]], "new file is extended");
4748 InitBasicFS, Always, TestOutput (
4749 [["write"; "/new"; "new file contents"];
4750 ["pwrite"; "/new"; ""; "4"];
4751 ["cat"; "/new"]], "new file contents")],
4752 "write to part of a file",
4754 This command writes to part of a file. It writes the data
4755 buffer C<content> to the file C<path> starting at offset C<offset>.
4757 This command implements the L<pwrite(2)> system call, and like
4758 that system call it may not write the full data requested. The
4759 return value is the number of bytes that were actually written
4760 to the file. This could even be 0, although short writes are
4761 unlikely for regular files in ordinary circumstances.
4763 See also C<guestfs_pread>.");
4765 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
4767 "resize an ext2, ext3 or ext4 filesystem (with size)",
4769 This command is the same as C<guestfs_resize2fs> except that it
4770 allows you to specify the new size (in bytes) explicitly.");
4772 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
4774 "resize an LVM physical volume (with size)",
4776 This command is the same as C<guestfs_pvresize> except that it
4777 allows you to specify the new size (in bytes) explicitly.");
4779 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"]), 250, [Optional "ntfsprogs"],
4781 "resize an NTFS filesystem (with size)",
4783 This command is the same as C<guestfs_ntfsresize> except that it
4784 allows you to specify the new size (in bytes) explicitly.");
4786 ("available_all_groups", (RStringList "groups", []), 251, [],
4787 [InitNone, Always, TestRun [["available_all_groups"]]],
4788 "return a list of all optional groups",
4790 This command returns a list of all optional groups that this
4791 daemon knows about. Note this returns both supported and unsupported
4792 groups. To find out which ones the daemon can actually support
4793 you have to call C<guestfs_available> on each member of the
4796 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4798 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"]), 252, [],
4799 [InitBasicFS, Always, TestOutputStruct (
4800 [["fallocate64"; "/a"; "1000000"];
4801 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4802 "preallocate a file in the guest filesystem",
4804 This command preallocates a file (containing zero bytes) named
4805 C<path> of size C<len> bytes. If the file exists already, it
4808 Note that this call allocates disk blocks for the file.
4809 To create a sparse file use C<guestfs_truncate_size> instead.
4811 The deprecated call C<guestfs_fallocate> does the same,
4812 but owing to an oversight it only allowed 30 bit lengths
4813 to be specified, effectively limiting the maximum size
4814 of files created through that call to 1GB.
4816 Do not confuse this with the guestfish-specific
4817 C<alloc> and C<sparse> commands which create
4818 a file in the host and attach it as a device.");
4820 ("vfs_label", (RString "label", [Device "device"]), 253, [],
4821 [InitBasicFS, Always, TestOutput (
4822 [["set_e2label"; "/dev/sda1"; "LTEST"];
4823 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4824 "get the filesystem label",
4826 This returns the filesystem label of the filesystem on
4829 If the filesystem is unlabeled, this returns the empty string.");
4831 ("vfs_uuid", (RString "uuid", [Device "device"]), 254, [],
4832 (let uuid = uuidgen () in
4833 [InitBasicFS, Always, TestOutput (
4834 [["set_e2uuid"; "/dev/sda1"; uuid];
4835 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4836 "get the filesystem UUID",
4838 This returns the filesystem UUID of the filesystem on
4841 If the filesystem does not have a UUID, this returns the empty string.");
4843 ("lvm_set_filter", (RErr, [DeviceList "devices"]), 255, [Optional "lvm2"],
4844 (* Can't be tested with the current framework because
4845 * the VG is being used by the mounted filesystem, so
4846 * the vgchange -an command we do first will fail.
4849 "set LVM device filter",
4851 This sets the LVM device filter so that LVM will only be
4852 able to \"see\" the block devices in the list C<devices>,
4853 and will ignore all other attached block devices.
4855 Where disk image(s) contain duplicate PVs or VGs, this
4856 command is useful to get LVM to ignore the duplicates, otherwise
4857 LVM can get confused. Note also there are two types
4858 of duplication possible: either cloned PVs/VGs which have
4859 identical UUIDs; or VGs that are not cloned but just happen
4860 to have the same name. In normal operation you cannot
4861 create this situation, but you can do it outside LVM, eg.
4862 by cloning disk images or by bit twiddling inside the LVM
4865 This command also clears the LVM cache and performs a volume
4868 You can filter whole block devices or individual partitions.
4870 You cannot use this if any VG is currently in use (eg.
4871 contains a mounted filesystem), even if you are not
4872 filtering out that VG.");
4874 ("lvm_clear_filter", (RErr, []), 256, [],
4875 [], (* see note on lvm_set_filter *)
4876 "clear LVM device filter",
4878 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
4879 will be able to see every block device.
4881 This command also clears the LVM cache and performs a volume
4884 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"]), 257, [Optional "luks"],
4886 "open a LUKS-encrypted block device",
4888 This command opens a block device which has been encrypted
4889 according to the Linux Unified Key Setup (LUKS) standard.
4891 C<device> is the encrypted block device or partition.
4893 The caller must supply one of the keys associated with the
4894 LUKS block device, in the C<key> parameter.
4896 This creates a new block device called C</dev/mapper/mapname>.
4897 Reads and writes to this block device are decrypted from and
4898 encrypted to the underlying C<device> respectively.
4900 If this block device contains LVM volume groups, then
4901 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
4902 will make them visible.");
4904 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"]), 258, [Optional "luks"],
4906 "open a LUKS-encrypted block device read-only",
4908 This is the same as C<guestfs_luks_open> except that a read-only
4909 mapping is created.");
4911 ("luks_close", (RErr, [Device "device"]), 259, [Optional "luks"],
4913 "close a LUKS device",
4915 This closes a LUKS device that was created earlier by
4916 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
4917 C<device> parameter must be the name of the LUKS mapping
4918 device (ie. C</dev/mapper/mapname>) and I<not> the name
4919 of the underlying block device.");
4923 let all_functions = non_daemon_functions @ daemon_functions
4925 (* In some places we want the functions to be displayed sorted
4926 * alphabetically, so this is useful:
4928 let all_functions_sorted =
4929 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4930 compare n1 n2) all_functions
4932 (* This is used to generate the src/MAX_PROC_NR file which
4933 * contains the maximum procedure number, a surrogate for the
4934 * ABI version number. See src/Makefile.am for the details.
4937 let proc_nrs = List.map (
4938 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4939 ) daemon_functions in
4940 List.fold_left max 0 proc_nrs
4942 (* Field types for structures. *)
4944 | FChar (* C 'char' (really, a 7 bit byte). *)
4945 | FString (* nul-terminated ASCII string, NOT NULL. *)
4946 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4951 | FBytes (* Any int measure that counts bytes. *)
4952 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4953 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4955 (* Because we generate extra parsing code for LVM command line tools,
4956 * we have to pull out the LVM columns separately here.
4966 "pv_attr", FString (* XXX *);
4967 "pv_pe_count", FInt64;
4968 "pv_pe_alloc_count", FInt64;
4971 "pv_mda_count", FInt64;
4972 "pv_mda_free", FBytes;
4973 (* Not in Fedora 10:
4974 "pv_mda_size", FBytes;
4981 "vg_attr", FString (* XXX *);
4984 "vg_sysid", FString;
4985 "vg_extent_size", FBytes;
4986 "vg_extent_count", FInt64;
4987 "vg_free_count", FInt64;
4992 "snap_count", FInt64;
4995 "vg_mda_count", FInt64;
4996 "vg_mda_free", FBytes;
4997 (* Not in Fedora 10:
4998 "vg_mda_size", FBytes;
5004 "lv_attr", FString (* XXX *);
5007 "lv_kernel_major", FInt64;
5008 "lv_kernel_minor", FInt64;
5010 "seg_count", FInt64;
5012 "snap_percent", FOptPercent;
5013 "copy_percent", FOptPercent;
5016 "mirror_log", FString;
5020 (* Names and fields in all structures (in RStruct and RStructList)
5024 (* The old RIntBool return type, only ever used for aug_defnode. Do
5025 * not use this struct in any new code.
5028 "i", FInt32; (* for historical compatibility *)
5029 "b", FInt32; (* for historical compatibility *)
5032 (* LVM PVs, VGs, LVs. *)
5033 "lvm_pv", lvm_pv_cols;
5034 "lvm_vg", lvm_vg_cols;
5035 "lvm_lv", lvm_lv_cols;
5037 (* Column names and types from stat structures.
5038 * NB. Can't use things like 'st_atime' because glibc header files
5039 * define some of these as macros. Ugh.
5070 (* Column names in dirent structure. *)
5073 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
5078 (* Version numbers. *)
5086 (* Extended attribute. *)
5088 "attrname", FString;
5092 (* Inotify events. *)
5096 "in_cookie", FUInt32;
5100 (* Partition table entry. *)
5103 "part_start", FBytes;
5105 "part_size", FBytes;
5107 ] (* end of structs *)
5109 (* Ugh, Java has to be different ..
5110 * These names are also used by the Haskell bindings.
5112 let java_structs = [
5113 "int_bool", "IntBool";
5118 "statvfs", "StatVFS";
5120 "version", "Version";
5122 "inotify_event", "INotifyEvent";
5123 "partition", "Partition";
5126 (* What structs are actually returned. *)
5127 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
5129 (* Returns a list of RStruct/RStructList structs that are returned
5130 * by any function. Each element of returned list is a pair:
5132 * (structname, RStructOnly)
5133 * == there exists function which returns RStruct (_, structname)
5134 * (structname, RStructListOnly)
5135 * == there exists function which returns RStructList (_, structname)
5136 * (structname, RStructAndList)
5137 * == there are functions returning both RStruct (_, structname)
5138 * and RStructList (_, structname)
5140 let rstructs_used_by functions =
5141 (* ||| is a "logical OR" for rstructs_used_t *)
5145 | _, RStructAndList -> RStructAndList
5146 | RStructOnly, RStructListOnly
5147 | RStructListOnly, RStructOnly -> RStructAndList
5148 | RStructOnly, RStructOnly -> RStructOnly
5149 | RStructListOnly, RStructListOnly -> RStructListOnly
5152 let h = Hashtbl.create 13 in
5154 (* if elem->oldv exists, update entry using ||| operator,
5155 * else just add elem->newv to the hash
5157 let update elem newv =
5158 try let oldv = Hashtbl.find h elem in
5159 Hashtbl.replace h elem (newv ||| oldv)
5160 with Not_found -> Hashtbl.add h elem newv
5164 fun (_, style, _, _, _, _, _) ->
5165 match fst style with
5166 | RStruct (_, structname) -> update structname RStructOnly
5167 | RStructList (_, structname) -> update structname RStructListOnly
5171 (* return key->values as a list of (key,value) *)
5172 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
5174 (* Used for testing language bindings. *)
5176 | CallString of string
5177 | CallOptString of string option
5178 | CallStringList of string list
5180 | CallInt64 of int64
5182 | CallBuffer of string
5184 (* Used to memoize the result of pod2text. *)
5185 let pod2text_memo_filename = "src/.pod2text.data"
5186 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
5188 let chan = open_in pod2text_memo_filename in
5189 let v = input_value chan in
5193 _ -> Hashtbl.create 13
5194 let pod2text_memo_updated () =
5195 let chan = open_out pod2text_memo_filename in
5196 output_value chan pod2text_memo;
5199 (* Useful functions.
5200 * Note we don't want to use any external OCaml libraries which
5201 * makes this a bit harder than it should be.
5203 module StringMap = Map.Make (String)
5205 let failwithf fs = ksprintf failwith fs
5207 let unique = let i = ref 0 in fun () -> incr i; !i
5209 let replace_char s c1 c2 =
5210 let s2 = String.copy s in
5211 let r = ref false in
5212 for i = 0 to String.length s2 - 1 do
5213 if String.unsafe_get s2 i = c1 then (
5214 String.unsafe_set s2 i c2;
5218 if not !r then s else s2
5222 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5224 let triml ?(test = isspace) str =
5226 let n = ref (String.length str) in
5227 while !n > 0 && test str.[!i]; do
5232 else String.sub str !i !n
5234 let trimr ?(test = isspace) str =
5235 let n = ref (String.length str) in
5236 while !n > 0 && test str.[!n-1]; do
5239 if !n = String.length str then str
5240 else String.sub str 0 !n
5242 let trim ?(test = isspace) str =
5243 trimr ~test (triml ~test str)
5245 let rec find s sub =
5246 let len = String.length s in
5247 let sublen = String.length sub in
5249 if i <= len-sublen then (
5251 if j < sublen then (
5252 if s.[i+j] = sub.[j] then loop2 (j+1)
5258 if r = -1 then loop (i+1) else r
5264 let rec replace_str s s1 s2 =
5265 let len = String.length s in
5266 let sublen = String.length s1 in
5267 let i = find s s1 in
5270 let s' = String.sub s 0 i in
5271 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5272 s' ^ s2 ^ replace_str s'' s1 s2
5275 let rec string_split sep str =
5276 let len = String.length str in
5277 let seplen = String.length sep in
5278 let i = find str sep in
5279 if i = -1 then [str]
5281 let s' = String.sub str 0 i in
5282 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5283 s' :: string_split sep s''
5286 let files_equal n1 n2 =
5287 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5288 match Sys.command cmd with
5291 | i -> failwithf "%s: failed with error code %d" cmd i
5293 let rec filter_map f = function
5297 | Some y -> y :: filter_map f xs
5298 | None -> filter_map f xs
5300 let rec find_map f = function
5301 | [] -> raise Not_found
5305 | None -> find_map f xs
5308 let rec loop i = function
5310 | x :: xs -> f i x; loop (i+1) xs
5315 let rec loop i = function
5317 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5321 let count_chars c str =
5322 let count = ref 0 in
5323 for i = 0 to String.length str - 1 do
5324 if c = String.unsafe_get str i then incr count
5330 for i = 0 to String.length str - 1 do
5331 let c = String.unsafe_get str i in
5336 let map_chars f str =
5337 List.map f (explode str)
5339 let name_of_argt = function
5340 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5341 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5342 | FileIn n | FileOut n | BufferIn n | Key n -> n
5344 let java_name_of_struct typ =
5345 try List.assoc typ java_structs
5348 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5350 let cols_of_struct typ =
5351 try List.assoc typ structs
5353 failwithf "cols_of_struct: unknown struct %s" typ
5355 let seq_of_test = function
5356 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5357 | TestOutputListOfDevices (s, _)
5358 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5359 | TestOutputTrue s | TestOutputFalse s
5360 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5361 | TestOutputStruct (s, _)
5362 | TestLastFail s -> s
5364 (* Handling for function flags. *)
5365 let protocol_limit_warning =
5366 "Because of the message protocol, there is a transfer limit
5367 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5369 let danger_will_robinson =
5370 "B<This command is dangerous. Without careful use you
5371 can easily destroy all your data>."
5373 let deprecation_notice flags =
5376 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5378 sprintf "This function is deprecated.
5379 In new code, use the C<%s> call instead.
5381 Deprecated functions will not be removed from the API, but the
5382 fact that they are deprecated indicates that there are problems
5383 with correct use of these functions." alt in
5388 (* Create list of optional groups. *)
5390 let h = Hashtbl.create 13 in
5392 fun (name, _, _, flags, _, _, _) ->
5396 let names = try Hashtbl.find h group with Not_found -> [] in
5397 Hashtbl.replace h group (name :: names)
5401 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5404 fun group -> group, List.sort compare (Hashtbl.find h group)
5406 List.sort (fun x y -> compare (fst x) (fst y)) groups
5408 (* Check function names etc. for consistency. *)
5409 let check_functions () =
5410 let contains_uppercase str =
5411 let len = String.length str in
5413 if i >= len then false
5416 if c >= 'A' && c <= 'Z' then true
5423 (* Check function names. *)
5425 fun (name, _, _, _, _, _, _) ->
5426 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5427 failwithf "function name %s does not need 'guestfs' prefix" name;
5429 failwithf "function name is empty";
5430 if name.[0] < 'a' || name.[0] > 'z' then
5431 failwithf "function name %s must start with lowercase a-z" name;
5432 if String.contains name '-' then
5433 failwithf "function name %s should not contain '-', use '_' instead."
5437 (* Check function parameter/return names. *)
5439 fun (name, style, _, _, _, _, _) ->
5440 let check_arg_ret_name n =
5441 if contains_uppercase n then
5442 failwithf "%s param/ret %s should not contain uppercase chars"
5444 if String.contains n '-' || String.contains n '_' then
5445 failwithf "%s param/ret %s should not contain '-' or '_'"
5448 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;
5449 if n = "int" || n = "char" || n = "short" || n = "long" then
5450 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5451 if n = "i" || n = "n" then
5452 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5453 if n = "argv" || n = "args" then
5454 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5456 (* List Haskell, OCaml and C keywords here.
5457 * http://www.haskell.org/haskellwiki/Keywords
5458 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5459 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5460 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5461 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5462 * Omitting _-containing words, since they're handled above.
5463 * Omitting the OCaml reserved word, "val", is ok,
5464 * and saves us from renaming several parameters.
5467 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5468 "char"; "class"; "const"; "constraint"; "continue"; "data";
5469 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5470 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5471 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5472 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5473 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5475 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5476 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5477 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5478 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5479 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5480 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5481 "volatile"; "when"; "where"; "while";
5483 if List.mem n reserved then
5484 failwithf "%s has param/ret using reserved word %s" name n;
5487 (match fst style with
5489 | RInt n | RInt64 n | RBool n
5490 | RConstString n | RConstOptString n | RString n
5491 | RStringList n | RStruct (n, _) | RStructList (n, _)
5492 | RHashtable n | RBufferOut n ->
5493 check_arg_ret_name n
5495 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5498 (* Check short descriptions. *)
5500 fun (name, _, _, _, _, shortdesc, _) ->
5501 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5502 failwithf "short description of %s should begin with lowercase." name;
5503 let c = shortdesc.[String.length shortdesc-1] in
5504 if c = '\n' || c = '.' then
5505 failwithf "short description of %s should not end with . or \\n." name
5508 (* Check long descriptions. *)
5510 fun (name, _, _, _, _, _, longdesc) ->
5511 if longdesc.[String.length longdesc-1] = '\n' then
5512 failwithf "long description of %s should not end with \\n." name
5515 (* Check proc_nrs. *)
5517 fun (name, _, proc_nr, _, _, _, _) ->
5518 if proc_nr <= 0 then
5519 failwithf "daemon function %s should have proc_nr > 0" name
5523 fun (name, _, proc_nr, _, _, _, _) ->
5524 if proc_nr <> -1 then
5525 failwithf "non-daemon function %s should have proc_nr -1" name
5526 ) non_daemon_functions;
5529 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5532 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5533 let rec loop = function
5536 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5538 | (name1,nr1) :: (name2,nr2) :: _ ->
5539 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5547 (* Ignore functions that have no tests. We generate a
5548 * warning when the user does 'make check' instead.
5550 | name, _, _, _, [], _, _ -> ()
5551 | name, _, _, _, tests, _, _ ->
5555 match seq_of_test test with
5557 failwithf "%s has a test containing an empty sequence" name
5558 | cmds -> List.map List.hd cmds
5560 let funcs = List.flatten funcs in
5562 let tested = List.mem name funcs in
5565 failwithf "function %s has tests but does not test itself" name
5568 (* 'pr' prints to the current output file. *)
5569 let chan = ref Pervasives.stdout
5574 let i = count_chars '\n' str in
5575 lines := !lines + i;
5576 output_string !chan str
5579 let copyright_years =
5580 let this_year = 1900 + (localtime (time ())).tm_year in
5581 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5583 (* Generate a header block in a number of standard styles. *)
5584 type comment_style =
5585 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5586 type license = GPLv2plus | LGPLv2plus
5588 let generate_header ?(extra_inputs = []) comment license =
5589 let inputs = "src/generator.ml" :: extra_inputs in
5590 let c = match comment with
5591 | CStyle -> pr "/* "; " *"
5592 | CPlusPlusStyle -> pr "// "; "//"
5593 | HashStyle -> pr "# "; "#"
5594 | OCamlStyle -> pr "(* "; " *"
5595 | HaskellStyle -> pr "{- "; " " in
5596 pr "libguestfs generated file\n";
5597 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5598 List.iter (pr "%s %s\n" c) inputs;
5599 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5601 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5605 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5606 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5607 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5608 pr "%s (at your option) any later version.\n" c;
5610 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5611 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5612 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5613 pr "%s GNU General Public License for more details.\n" c;
5615 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5616 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5617 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5620 pr "%s This library is free software; you can redistribute it and/or\n" c;
5621 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5622 pr "%s License as published by the Free Software Foundation; either\n" c;
5623 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5625 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5626 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5627 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5628 pr "%s Lesser General Public License for more details.\n" c;
5630 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5631 pr "%s License along with this library; if not, write to the Free Software\n" c;
5632 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5635 | CStyle -> pr " */\n"
5638 | OCamlStyle -> pr " *)\n"
5639 | HaskellStyle -> pr "-}\n"
5643 (* Start of main code generation functions below this line. *)
5645 (* Generate the pod documentation for the C API. *)
5646 let rec generate_actions_pod () =
5648 fun (shortname, style, _, flags, _, _, longdesc) ->
5649 if not (List.mem NotInDocs flags) then (
5650 let name = "guestfs_" ^ shortname in
5651 pr "=head2 %s\n\n" name;
5653 generate_prototype ~extern:false ~handle:"g" name style;
5655 pr "%s\n\n" longdesc;
5656 (match fst style with
5658 pr "This function returns 0 on success or -1 on error.\n\n"
5660 pr "On error this function returns -1.\n\n"
5662 pr "On error this function returns -1.\n\n"
5664 pr "This function returns a C truth value on success or -1 on error.\n\n"
5666 pr "This function returns a string, or NULL on error.
5667 The string is owned by the guest handle and must I<not> be freed.\n\n"
5668 | RConstOptString _ ->
5669 pr "This function returns a string which may be NULL.
5670 There is way to return an error from this function.
5671 The string is owned by the guest handle and must I<not> be freed.\n\n"
5673 pr "This function returns a string, or NULL on error.
5674 I<The caller must free the returned string after use>.\n\n"
5676 pr "This function returns a NULL-terminated array of strings
5677 (like L<environ(3)>), or NULL if there was an error.
5678 I<The caller must free the strings and the array after use>.\n\n"
5679 | RStruct (_, typ) ->
5680 pr "This function returns a C<struct guestfs_%s *>,
5681 or NULL if there was an error.
5682 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5683 | RStructList (_, typ) ->
5684 pr "This function returns a C<struct guestfs_%s_list *>
5685 (see E<lt>guestfs-structs.hE<gt>),
5686 or NULL if there was an error.
5687 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5689 pr "This function returns a NULL-terminated array of
5690 strings, or NULL if there was an error.
5691 The array of strings will always have length C<2n+1>, where
5692 C<n> keys and values alternate, followed by the trailing NULL entry.
5693 I<The caller must free the strings and the array after use>.\n\n"
5695 pr "This function returns a buffer, or NULL on error.
5696 The size of the returned buffer is written to C<*size_r>.
5697 I<The caller must free the returned buffer after use>.\n\n"
5699 if List.mem ProtocolLimitWarning flags then
5700 pr "%s\n\n" protocol_limit_warning;
5701 if List.mem DangerWillRobinson flags then
5702 pr "%s\n\n" danger_will_robinson;
5703 if List.exists (function Key _ -> true | _ -> false) (snd style) then
5704 pr "This function takes a key or passphrase parameter which
5705 could contain sensitive material. Read the section
5706 L</KEYS AND PASSPHRASES> for more information.\n\n";
5707 match deprecation_notice flags with
5709 | Some txt -> pr "%s\n\n" txt
5711 ) all_functions_sorted
5713 and generate_structs_pod () =
5714 (* Structs documentation. *)
5717 pr "=head2 guestfs_%s\n" typ;
5719 pr " struct guestfs_%s {\n" typ;
5722 | name, FChar -> pr " char %s;\n" name
5723 | name, FUInt32 -> pr " uint32_t %s;\n" name
5724 | name, FInt32 -> pr " int32_t %s;\n" name
5725 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5726 | name, FInt64 -> pr " int64_t %s;\n" name
5727 | name, FString -> pr " char *%s;\n" name
5729 pr " /* The next two fields describe a byte array. */\n";
5730 pr " uint32_t %s_len;\n" name;
5731 pr " char *%s;\n" name
5733 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5734 pr " char %s[32];\n" name
5735 | name, FOptPercent ->
5736 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5737 pr " float %s;\n" name
5741 pr " struct guestfs_%s_list {\n" typ;
5742 pr " uint32_t len; /* Number of elements in list. */\n";
5743 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5746 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5747 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5752 and generate_availability_pod () =
5753 (* Availability documentation. *)
5757 fun (group, functions) ->
5758 pr "=item B<%s>\n" group;
5760 pr "The following functions:\n";
5761 List.iter (pr "L</guestfs_%s>\n") functions;
5767 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5768 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5770 * We have to use an underscore instead of a dash because otherwise
5771 * rpcgen generates incorrect code.
5773 * This header is NOT exported to clients, but see also generate_structs_h.
5775 and generate_xdr () =
5776 generate_header CStyle LGPLv2plus;
5778 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5779 pr "typedef string str<>;\n";
5782 (* Internal structures. *)
5786 pr "struct guestfs_int_%s {\n" typ;
5788 | name, FChar -> pr " char %s;\n" name
5789 | name, FString -> pr " string %s<>;\n" name
5790 | name, FBuffer -> pr " opaque %s<>;\n" name
5791 | name, FUUID -> pr " opaque %s[32];\n" name
5792 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5793 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5794 | name, FOptPercent -> pr " float %s;\n" name
5798 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5803 fun (shortname, style, _, _, _, _, _) ->
5804 let name = "guestfs_" ^ shortname in
5806 (match snd style with
5809 pr "struct %s_args {\n" name;
5812 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
5813 pr " string %s<>;\n" n
5814 | OptString n -> pr " str *%s;\n" n
5815 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5816 | Bool n -> pr " bool %s;\n" n
5817 | Int n -> pr " int %s;\n" n
5818 | Int64 n -> pr " hyper %s;\n" n
5820 pr " opaque %s<>;\n" n
5821 | FileIn _ | FileOut _ -> ()
5825 (match fst style with
5828 pr "struct %s_ret {\n" name;
5832 pr "struct %s_ret {\n" name;
5833 pr " hyper %s;\n" n;
5836 pr "struct %s_ret {\n" name;
5839 | RConstString _ | RConstOptString _ ->
5840 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5842 pr "struct %s_ret {\n" name;
5843 pr " string %s<>;\n" n;
5846 pr "struct %s_ret {\n" name;
5847 pr " str %s<>;\n" n;
5849 | RStruct (n, typ) ->
5850 pr "struct %s_ret {\n" name;
5851 pr " guestfs_int_%s %s;\n" typ n;
5853 | RStructList (n, typ) ->
5854 pr "struct %s_ret {\n" name;
5855 pr " guestfs_int_%s_list %s;\n" typ n;
5858 pr "struct %s_ret {\n" name;
5859 pr " str %s<>;\n" n;
5862 pr "struct %s_ret {\n" name;
5863 pr " opaque %s<>;\n" n;
5868 (* Table of procedure numbers. *)
5869 pr "enum guestfs_procedure {\n";
5871 fun (shortname, _, proc_nr, _, _, _, _) ->
5872 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5874 pr " GUESTFS_PROC_NR_PROCS\n";
5878 (* Having to choose a maximum message size is annoying for several
5879 * reasons (it limits what we can do in the API), but it (a) makes
5880 * the protocol a lot simpler, and (b) provides a bound on the size
5881 * of the daemon which operates in limited memory space.
5883 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5886 (* Message header, etc. *)
5888 /* The communication protocol is now documented in the guestfs(3)
5892 const GUESTFS_PROGRAM = 0x2000F5F5;
5893 const GUESTFS_PROTOCOL_VERSION = 1;
5895 /* These constants must be larger than any possible message length. */
5896 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5897 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5899 enum guestfs_message_direction {
5900 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5901 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5904 enum guestfs_message_status {
5905 GUESTFS_STATUS_OK = 0,
5906 GUESTFS_STATUS_ERROR = 1
5909 const GUESTFS_ERROR_LEN = 256;
5911 struct guestfs_message_error {
5912 string error_message<GUESTFS_ERROR_LEN>;
5915 struct guestfs_message_header {
5916 unsigned prog; /* GUESTFS_PROGRAM */
5917 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5918 guestfs_procedure proc; /* GUESTFS_PROC_x */
5919 guestfs_message_direction direction;
5920 unsigned serial; /* message serial number */
5921 guestfs_message_status status;
5924 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5926 struct guestfs_chunk {
5927 int cancel; /* if non-zero, transfer is cancelled */
5928 /* data size is 0 bytes if the transfer has finished successfully */
5929 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5933 (* Generate the guestfs-structs.h file. *)
5934 and generate_structs_h () =
5935 generate_header CStyle LGPLv2plus;
5937 (* This is a public exported header file containing various
5938 * structures. The structures are carefully written to have
5939 * exactly the same in-memory format as the XDR structures that
5940 * we use on the wire to the daemon. The reason for creating
5941 * copies of these structures here is just so we don't have to
5942 * export the whole of guestfs_protocol.h (which includes much
5943 * unrelated and XDR-dependent stuff that we don't want to be
5944 * public, or required by clients).
5946 * To reiterate, we will pass these structures to and from the
5947 * client with a simple assignment or memcpy, so the format
5948 * must be identical to what rpcgen / the RFC defines.
5951 (* Public structures. *)
5954 pr "struct guestfs_%s {\n" typ;
5957 | name, FChar -> pr " char %s;\n" name
5958 | name, FString -> pr " char *%s;\n" name
5960 pr " uint32_t %s_len;\n" name;
5961 pr " char *%s;\n" name
5962 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5963 | name, FUInt32 -> pr " uint32_t %s;\n" name
5964 | name, FInt32 -> pr " int32_t %s;\n" name
5965 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5966 | name, FInt64 -> pr " int64_t %s;\n" name
5967 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5971 pr "struct guestfs_%s_list {\n" typ;
5972 pr " uint32_t len;\n";
5973 pr " struct guestfs_%s *val;\n" typ;
5976 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5977 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5981 (* Generate the guestfs-actions.h file. *)
5982 and generate_actions_h () =
5983 generate_header CStyle LGPLv2plus;
5985 fun (shortname, style, _, _, _, _, _) ->
5986 let name = "guestfs_" ^ shortname in
5987 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5991 (* Generate the guestfs-internal-actions.h file. *)
5992 and generate_internal_actions_h () =
5993 generate_header CStyle LGPLv2plus;
5995 fun (shortname, style, _, _, _, _, _) ->
5996 let name = "guestfs__" ^ shortname in
5997 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5999 ) non_daemon_functions
6001 (* Generate the client-side dispatch stubs. *)
6002 and generate_client_actions () =
6003 generate_header CStyle LGPLv2plus;
6010 #include <inttypes.h>
6012 #include \"guestfs.h\"
6013 #include \"guestfs-internal.h\"
6014 #include \"guestfs-internal-actions.h\"
6015 #include \"guestfs_protocol.h\"
6017 #define error guestfs_error
6018 //#define perrorf guestfs_perrorf
6019 #define safe_malloc guestfs_safe_malloc
6020 #define safe_realloc guestfs_safe_realloc
6021 //#define safe_strdup guestfs_safe_strdup
6022 #define safe_memdup guestfs_safe_memdup
6024 /* Check the return message from a call for validity. */
6026 check_reply_header (guestfs_h *g,
6027 const struct guestfs_message_header *hdr,
6028 unsigned int proc_nr, unsigned int serial)
6030 if (hdr->prog != GUESTFS_PROGRAM) {
6031 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
6034 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
6035 error (g, \"wrong protocol version (%%d/%%d)\",
6036 hdr->vers, GUESTFS_PROTOCOL_VERSION);
6039 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
6040 error (g, \"unexpected message direction (%%d/%%d)\",
6041 hdr->direction, GUESTFS_DIRECTION_REPLY);
6044 if (hdr->proc != proc_nr) {
6045 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
6048 if (hdr->serial != serial) {
6049 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
6056 /* Check we are in the right state to run a high-level action. */
6058 check_state (guestfs_h *g, const char *caller)
6060 if (!guestfs__is_ready (g)) {
6061 if (guestfs__is_config (g) || guestfs__is_launching (g))
6062 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
6065 error (g, \"%%s called from the wrong state, %%d != READY\",
6066 caller, guestfs__get_state (g));
6074 let error_code_of = function
6075 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
6076 | RConstString _ | RConstOptString _
6077 | RString _ | RStringList _
6078 | RStruct _ | RStructList _
6079 | RHashtable _ | RBufferOut _ -> "NULL"
6082 (* Generate code to check String-like parameters are not passed in
6083 * as NULL (returning an error if they are).
6085 let check_null_strings shortname style =
6086 let pr_newline = ref false in
6089 (* parameters which should not be NULL *)
6100 pr " if (%s == NULL) {\n" n;
6101 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
6102 pr " \"%s\", \"%s\");\n" shortname n;
6103 pr " return %s;\n" (error_code_of (fst style));
6110 (* not applicable *)
6116 if !pr_newline then pr "\n";
6119 (* Generate code to generate guestfish call traces. *)
6120 let trace_call shortname style =
6121 pr " if (guestfs__get_trace (g)) {\n";
6124 List.exists (function
6125 | StringList _ | DeviceList _ -> true
6126 | _ -> false) (snd style) in
6132 pr " printf (\"%s\");\n" shortname;
6135 | String n (* strings *)
6143 (* guestfish doesn't support string escaping, so neither do we *)
6144 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
6145 | OptString n -> (* string option *)
6146 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
6147 pr " else printf (\" null\");\n"
6149 | DeviceList n -> (* string list *)
6150 pr " putchar (' ');\n";
6151 pr " putchar ('\"');\n";
6152 pr " for (i = 0; %s[i]; ++i) {\n" n;
6153 pr " if (i > 0) putchar (' ');\n";
6154 pr " fputs (%s[i], stdout);\n" n;
6156 pr " putchar ('\"');\n";
6157 | Bool n -> (* boolean *)
6158 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
6159 | Int n -> (* int *)
6160 pr " printf (\" %%d\", %s);\n" n
6162 pr " printf (\" %%\" PRIi64, %s);\n" n
6164 pr " putchar ('\\n');\n";
6169 (* For non-daemon functions, generate a wrapper around each function. *)
6171 fun (shortname, style, _, _, _, _, _) ->
6172 let name = "guestfs_" ^ shortname in
6174 generate_prototype ~extern:false ~semicolon:false ~newline:true
6175 ~handle:"g" name style;
6177 check_null_strings shortname style;
6178 trace_call shortname style;
6179 pr " return guestfs__%s " shortname;
6180 generate_c_call_args ~handle:"g" style;
6184 ) non_daemon_functions;
6186 (* Client-side stubs for each function. *)
6188 fun (shortname, style, _, _, _, _, _) ->
6189 let name = "guestfs_" ^ shortname in
6190 let error_code = error_code_of (fst style) in
6192 (* Generate the action stub. *)
6193 generate_prototype ~extern:false ~semicolon:false ~newline:true
6194 ~handle:"g" name style;
6198 (match snd style with
6200 | _ -> pr " struct %s_args args;\n" name
6203 pr " guestfs_message_header hdr;\n";
6204 pr " guestfs_message_error err;\n";
6206 match fst style with
6208 | RConstString _ | RConstOptString _ ->
6209 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6211 | RBool _ | RString _ | RStringList _
6212 | RStruct _ | RStructList _
6213 | RHashtable _ | RBufferOut _ ->
6214 pr " struct %s_ret ret;\n" name;
6217 pr " int serial;\n";
6220 check_null_strings shortname style;
6221 trace_call shortname style;
6222 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
6223 shortname error_code;
6224 pr " guestfs___set_busy (g);\n";
6227 (* Send the main header and arguments. *)
6228 (match snd style with
6230 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6231 (String.uppercase shortname)
6235 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
6236 pr " args.%s = (char *) %s;\n" n n
6238 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6239 | StringList n | DeviceList n ->
6240 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6241 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6243 pr " args.%s = %s;\n" n n
6245 pr " args.%s = %s;\n" n n
6247 pr " args.%s = %s;\n" n n
6248 | FileIn _ | FileOut _ -> ()
6250 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6251 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6252 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6254 pr " guestfs___end_busy (g);\n";
6255 pr " return %s;\n" error_code;
6257 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6258 pr " args.%s.%s_len = %s_size;\n" n n n
6260 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6261 (String.uppercase shortname);
6262 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6265 pr " if (serial == -1) {\n";
6266 pr " guestfs___end_busy (g);\n";
6267 pr " return %s;\n" error_code;
6271 (* Send any additional files (FileIn) requested. *)
6272 let need_read_reply_label = ref false in
6276 pr " r = guestfs___send_file (g, %s);\n" n;
6277 pr " if (r == -1) {\n";
6278 pr " guestfs___end_busy (g);\n";
6279 pr " return %s;\n" error_code;
6281 pr " if (r == -2) /* daemon cancelled */\n";
6282 pr " goto read_reply;\n";
6283 need_read_reply_label := true;
6288 (* Wait for the reply from the remote end. *)
6289 if !need_read_reply_label then pr " read_reply:\n";
6290 pr " memset (&hdr, 0, sizeof hdr);\n";
6291 pr " memset (&err, 0, sizeof err);\n";
6292 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6294 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6298 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6301 pr " if (r == -1) {\n";
6302 pr " guestfs___end_busy (g);\n";
6303 pr " return %s;\n" error_code;
6307 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6308 (String.uppercase shortname);
6309 pr " guestfs___end_busy (g);\n";
6310 pr " return %s;\n" error_code;
6314 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6315 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6316 pr " free (err.error_message);\n";
6317 pr " guestfs___end_busy (g);\n";
6318 pr " return %s;\n" error_code;
6322 (* Expecting to receive further files (FileOut)? *)
6326 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6327 pr " guestfs___end_busy (g);\n";
6328 pr " return %s;\n" error_code;
6334 pr " guestfs___end_busy (g);\n";
6336 (match fst style with
6337 | RErr -> pr " return 0;\n"
6338 | RInt n | RInt64 n | RBool n ->
6339 pr " return ret.%s;\n" n
6340 | RConstString _ | RConstOptString _ ->
6341 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6343 pr " return ret.%s; /* caller will free */\n" n
6344 | RStringList n | RHashtable n ->
6345 pr " /* caller will free this, but we need to add a NULL entry */\n";
6346 pr " ret.%s.%s_val =\n" n n;
6347 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6348 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6350 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6351 pr " return ret.%s.%s_val;\n" n n
6353 pr " /* caller will free this */\n";
6354 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6355 | RStructList (n, _) ->
6356 pr " /* caller will free this */\n";
6357 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6359 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6360 pr " * _val might be NULL here. To make the API saner for\n";
6361 pr " * callers, we turn this case into a unique pointer (using\n";
6362 pr " * malloc(1)).\n";
6364 pr " if (ret.%s.%s_len > 0) {\n" n n;
6365 pr " *size_r = ret.%s.%s_len;\n" n n;
6366 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6368 pr " free (ret.%s.%s_val);\n" n n;
6369 pr " char *p = safe_malloc (g, 1);\n";
6370 pr " *size_r = ret.%s.%s_len;\n" n n;
6378 (* Functions to free structures. *)
6379 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6380 pr " * structure format is identical to the XDR format. See note in\n";
6381 pr " * generator.ml.\n";
6388 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6390 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6396 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6398 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6405 (* Generate daemon/actions.h. *)
6406 and generate_daemon_actions_h () =
6407 generate_header CStyle GPLv2plus;
6409 pr "#include \"../src/guestfs_protocol.h\"\n";
6413 fun (name, style, _, _, _, _, _) ->
6415 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6419 (* Generate the linker script which controls the visibility of
6420 * symbols in the public ABI and ensures no other symbols get
6421 * exported accidentally.
6423 and generate_linker_script () =
6424 generate_header HashStyle GPLv2plus;
6429 "guestfs_get_error_handler";
6430 "guestfs_get_out_of_memory_handler";
6431 "guestfs_last_error";
6432 "guestfs_set_close_callback";
6433 "guestfs_set_error_handler";
6434 "guestfs_set_launch_done_callback";
6435 "guestfs_set_log_message_callback";
6436 "guestfs_set_out_of_memory_handler";
6437 "guestfs_set_subprocess_quit_callback";
6439 (* Unofficial parts of the API: the bindings code use these
6440 * functions, so it is useful to export them.
6442 "guestfs_safe_calloc";
6443 "guestfs_safe_malloc";
6444 "guestfs_safe_strdup";
6445 "guestfs_safe_memdup";
6448 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6452 List.map (fun (typ, _) ->
6453 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6456 let globals = List.sort compare (globals @ functions @ structs) in
6460 List.iter (pr " %s;\n") globals;
6467 (* Generate the server-side stubs. *)
6468 and generate_daemon_actions () =
6469 generate_header CStyle GPLv2plus;
6471 pr "#include <config.h>\n";
6473 pr "#include <stdio.h>\n";
6474 pr "#include <stdlib.h>\n";
6475 pr "#include <string.h>\n";
6476 pr "#include <inttypes.h>\n";
6477 pr "#include <rpc/types.h>\n";
6478 pr "#include <rpc/xdr.h>\n";
6480 pr "#include \"daemon.h\"\n";
6481 pr "#include \"c-ctype.h\"\n";
6482 pr "#include \"../src/guestfs_protocol.h\"\n";
6483 pr "#include \"actions.h\"\n";
6487 fun (name, style, _, _, _, _, _) ->
6488 (* Generate server-side stubs. *)
6489 pr "static void %s_stub (XDR *xdr_in)\n" name;
6492 match fst style with
6493 | RErr | RInt _ -> pr " int r;\n"; "-1"
6494 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6495 | RBool _ -> pr " int r;\n"; "-1"
6496 | RConstString _ | RConstOptString _ ->
6497 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6498 | RString _ -> pr " char *r;\n"; "NULL"
6499 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6500 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6501 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6503 pr " size_t size = 1;\n";
6507 (match snd style with
6510 pr " struct guestfs_%s_args args;\n" name;
6513 | Device n | Dev_or_Path n
6517 | OptString n -> pr " char *%s;\n" n
6518 | StringList n | DeviceList n -> pr " char **%s;\n" n
6519 | Bool n -> pr " int %s;\n" n
6520 | Int n -> pr " int %s;\n" n
6521 | Int64 n -> pr " int64_t %s;\n" n
6522 | FileIn _ | FileOut _ -> ()
6524 pr " const char *%s;\n" n;
6525 pr " size_t %s_size;\n" n
6531 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6533 (match snd style with
6536 pr " memset (&args, 0, sizeof args);\n";
6538 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6540 pr " if (cancel_receive () != -2)\n";
6541 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6545 pr " char *%s = args.%s;\n" n n
6547 let pr_list_handling_code n =
6548 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6549 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6550 pr " if (%s == NULL) {\n" n;
6552 pr " if (cancel_receive () != -2)\n";
6553 pr " reply_with_perror (\"realloc\");\n";
6556 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6557 pr " args.%s.%s_val = %s;\n" n n n;
6563 pr " ABS_PATH (%s, %s, goto done);\n"
6564 n (if is_filein then "cancel_receive ()" else "0");
6567 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6568 n (if is_filein then "cancel_receive ()" else "0");
6571 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6572 n (if is_filein then "cancel_receive ()" else "0");
6573 | String n | Key n -> pr_args n
6574 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6576 pr_list_handling_code n;
6578 pr_list_handling_code n;
6579 pr " /* Ensure that each is a device,\n";
6580 pr " * and perform device name translation.\n";
6584 pr " for (i = 0; %s[i] != NULL; ++i)\n" n;
6585 pr " RESOLVE_DEVICE (%s[i], %s, goto done);\n" n
6586 (if is_filein then "cancel_receive ()" else "0");
6588 | Bool n -> pr " %s = args.%s;\n" n n
6589 | Int n -> pr " %s = args.%s;\n" n n
6590 | Int64 n -> pr " %s = args.%s;\n" n n
6591 | FileIn _ | FileOut _ -> ()
6593 pr " %s = args.%s.%s_val;\n" n n n;
6594 pr " %s_size = args.%s.%s_len;\n" n n n
6599 (* this is used at least for do_equal *)
6600 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6601 (* Emit NEED_ROOT just once, even when there are two or
6602 more Pathname args *)
6603 pr " NEED_ROOT (%s, goto done);\n"
6604 (if is_filein then "cancel_receive ()" else "0");
6607 (* Don't want to call the impl with any FileIn or FileOut
6608 * parameters, since these go "outside" the RPC protocol.
6611 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6613 pr " r = do_%s " name;
6614 generate_c_call_args (fst style, args');
6617 (match fst style with
6618 | RErr | RInt _ | RInt64 _ | RBool _
6619 | RConstString _ | RConstOptString _
6620 | RString _ | RStringList _ | RHashtable _
6621 | RStruct (_, _) | RStructList (_, _) ->
6622 pr " if (r == %s)\n" error_code;
6623 pr " /* do_%s has already called reply_with_error */\n" name;
6627 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6628 pr " * an ordinary zero-length buffer), so be careful ...\n";
6630 pr " if (size == 1 && r == %s)\n" error_code;
6631 pr " /* do_%s has already called reply_with_error */\n" name;
6636 (* If there are any FileOut parameters, then the impl must
6637 * send its own reply.
6640 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6642 pr " /* do_%s has already sent a reply */\n" name
6644 match fst style with
6645 | RErr -> pr " reply (NULL, NULL);\n"
6646 | RInt n | RInt64 n | RBool n ->
6647 pr " struct guestfs_%s_ret ret;\n" name;
6648 pr " ret.%s = r;\n" n;
6649 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6651 | RConstString _ | RConstOptString _ ->
6652 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6654 pr " struct guestfs_%s_ret ret;\n" name;
6655 pr " ret.%s = r;\n" n;
6656 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6659 | RStringList n | RHashtable n ->
6660 pr " struct guestfs_%s_ret ret;\n" name;
6661 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6662 pr " ret.%s.%s_val = r;\n" n n;
6663 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6665 pr " free_strings (r);\n"
6667 pr " struct guestfs_%s_ret ret;\n" name;
6668 pr " ret.%s = *r;\n" n;
6669 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6671 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6673 | RStructList (n, _) ->
6674 pr " struct guestfs_%s_ret ret;\n" name;
6675 pr " ret.%s = *r;\n" n;
6676 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6678 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6681 pr " struct guestfs_%s_ret ret;\n" name;
6682 pr " ret.%s.%s_val = r;\n" n n;
6683 pr " ret.%s.%s_len = size;\n" n n;
6684 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6689 (* Free the args. *)
6691 (match snd style with
6694 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6701 (* Dispatch function. *)
6702 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6704 pr " switch (proc_nr) {\n";
6707 fun (name, style, _, _, _, _, _) ->
6708 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6709 pr " %s_stub (xdr_in);\n" name;
6714 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";
6719 (* LVM columns and tokenization functions. *)
6720 (* XXX This generates crap code. We should rethink how we
6726 pr "static const char *lvm_%s_cols = \"%s\";\n"
6727 typ (String.concat "," (List.map fst cols));
6730 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6732 pr " char *tok, *p, *next;\n";
6733 pr " size_t i, j;\n";
6736 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6739 pr " if (!str) {\n";
6740 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6743 pr " if (!*str || c_isspace (*str)) {\n";
6744 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6749 fun (name, coltype) ->
6750 pr " if (!tok) {\n";
6751 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6754 pr " p = strchrnul (tok, ',');\n";
6755 pr " if (*p) next = p+1; else next = NULL;\n";
6756 pr " *p = '\\0';\n";
6759 pr " r->%s = strdup (tok);\n" name;
6760 pr " if (r->%s == NULL) {\n" name;
6761 pr " perror (\"strdup\");\n";
6765 pr " for (i = j = 0; i < 32; ++j) {\n";
6766 pr " if (tok[j] == '\\0') {\n";
6767 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6769 pr " } else if (tok[j] != '-')\n";
6770 pr " r->%s[i++] = tok[j];\n" name;
6773 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6774 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6778 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6779 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6783 pr " if (tok[0] == '\\0')\n";
6784 pr " r->%s = -1;\n" name;
6785 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6786 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6789 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6790 assert false (* can never be an LVM column *)
6792 pr " tok = next;\n";
6795 pr " if (tok != NULL) {\n";
6796 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6803 pr "guestfs_int_lvm_%s_list *\n" typ;
6804 pr "parse_command_line_%ss (void)\n" typ;
6806 pr " char *out, *err;\n";
6807 pr " char *p, *pend;\n";
6809 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6810 pr " void *newp;\n";
6812 pr " ret = malloc (sizeof *ret);\n";
6813 pr " if (!ret) {\n";
6814 pr " reply_with_perror (\"malloc\");\n";
6815 pr " return NULL;\n";
6818 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6819 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6821 pr " r = command (&out, &err,\n";
6822 pr " \"lvm\", \"%ss\",\n" typ;
6823 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6824 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6825 pr " if (r == -1) {\n";
6826 pr " reply_with_error (\"%%s\", err);\n";
6827 pr " free (out);\n";
6828 pr " free (err);\n";
6829 pr " free (ret);\n";
6830 pr " return NULL;\n";
6833 pr " free (err);\n";
6835 pr " /* Tokenize each line of the output. */\n";
6838 pr " while (p) {\n";
6839 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6840 pr " if (pend) {\n";
6841 pr " *pend = '\\0';\n";
6845 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6848 pr " if (!*p) { /* Empty line? Skip it. */\n";
6853 pr " /* Allocate some space to store this next entry. */\n";
6854 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6855 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6856 pr " if (newp == NULL) {\n";
6857 pr " reply_with_perror (\"realloc\");\n";
6858 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6859 pr " free (ret);\n";
6860 pr " free (out);\n";
6861 pr " return NULL;\n";
6863 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6865 pr " /* Tokenize the next entry. */\n";
6866 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6867 pr " if (r == -1) {\n";
6868 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6869 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6870 pr " free (ret);\n";
6871 pr " free (out);\n";
6872 pr " return NULL;\n";
6879 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6881 pr " free (out);\n";
6882 pr " return ret;\n";
6885 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6887 (* Generate a list of function names, for debugging in the daemon.. *)
6888 and generate_daemon_names () =
6889 generate_header CStyle GPLv2plus;
6891 pr "#include <config.h>\n";
6893 pr "#include \"daemon.h\"\n";
6896 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6897 pr "const char *function_names[] = {\n";
6899 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6903 (* Generate the optional groups for the daemon to implement
6904 * guestfs_available.
6906 and generate_daemon_optgroups_c () =
6907 generate_header CStyle GPLv2plus;
6909 pr "#include <config.h>\n";
6911 pr "#include \"daemon.h\"\n";
6912 pr "#include \"optgroups.h\"\n";
6915 pr "struct optgroup optgroups[] = {\n";
6918 pr " { \"%s\", optgroup_%s_available },\n" group group
6920 pr " { NULL, NULL }\n";
6923 and generate_daemon_optgroups_h () =
6924 generate_header CStyle GPLv2plus;
6928 pr "extern int optgroup_%s_available (void);\n" group
6931 (* Generate the tests. *)
6932 and generate_tests () =
6933 generate_header CStyle GPLv2plus;
6940 #include <sys/types.h>
6943 #include \"guestfs.h\"
6944 #include \"guestfs-internal.h\"
6946 static guestfs_h *g;
6947 static int suppress_error = 0;
6949 static void print_error (guestfs_h *g, void *data, const char *msg)
6951 if (!suppress_error)
6952 fprintf (stderr, \"%%s\\n\", msg);
6955 /* FIXME: nearly identical code appears in fish.c */
6956 static void print_strings (char *const *argv)
6960 for (argc = 0; argv[argc] != NULL; ++argc)
6961 printf (\"\\t%%s\\n\", argv[argc]);
6965 static void print_table (char const *const *argv)
6969 for (i = 0; argv[i] != NULL; i += 2)
6970 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6975 is_available (const char *group)
6977 const char *groups[] = { group, NULL };
6981 r = guestfs_available (g, (char **) groups);
6988 incr (guestfs_h *g, void *iv)
6990 int *i = (int *) iv;
6996 (* Generate a list of commands which are not tested anywhere. *)
6997 pr "static void no_test_warnings (void)\n";
7000 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
7002 fun (_, _, _, _, tests, _, _) ->
7003 let tests = filter_map (
7005 | (_, (Always|If _|Unless _|IfAvailable _), test) -> Some test
7006 | (_, Disabled, _) -> None
7008 let seq = List.concat (List.map seq_of_test tests) in
7009 let cmds_tested = List.map List.hd seq in
7010 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
7014 fun (name, _, _, _, _, _, _) ->
7015 if not (Hashtbl.mem hash name) then
7016 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
7022 (* Generate the actual tests. Note that we generate the tests
7023 * in reverse order, deliberately, so that (in general) the
7024 * newest tests run first. This makes it quicker and easier to
7029 fun (name, _, _, flags, tests, _, _) ->
7030 mapi (generate_one_test name flags) tests
7031 ) (List.rev all_functions) in
7032 let test_names = List.concat test_names in
7033 let nr_tests = List.length test_names in
7036 int main (int argc, char *argv[])
7039 unsigned long int n_failed = 0;
7040 const char *filename;
7042 int nr_tests, test_num = 0;
7044 setbuf (stdout, NULL);
7046 no_test_warnings ();
7048 g = guestfs_create ();
7050 printf (\"guestfs_create FAILED\\n\");
7051 exit (EXIT_FAILURE);
7054 guestfs_set_error_handler (g, print_error, NULL);
7056 guestfs_set_path (g, \"../appliance\");
7058 filename = \"test1.img\";
7059 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7062 exit (EXIT_FAILURE);
7064 if (lseek (fd, %d, SEEK_SET) == -1) {
7068 exit (EXIT_FAILURE);
7070 if (write (fd, &c, 1) == -1) {
7074 exit (EXIT_FAILURE);
7076 if (close (fd) == -1) {
7079 exit (EXIT_FAILURE);
7081 if (guestfs_add_drive (g, filename) == -1) {
7082 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7083 exit (EXIT_FAILURE);
7086 filename = \"test2.img\";
7087 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7090 exit (EXIT_FAILURE);
7092 if (lseek (fd, %d, SEEK_SET) == -1) {
7096 exit (EXIT_FAILURE);
7098 if (write (fd, &c, 1) == -1) {
7102 exit (EXIT_FAILURE);
7104 if (close (fd) == -1) {
7107 exit (EXIT_FAILURE);
7109 if (guestfs_add_drive (g, filename) == -1) {
7110 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7111 exit (EXIT_FAILURE);
7114 filename = \"test3.img\";
7115 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7118 exit (EXIT_FAILURE);
7120 if (lseek (fd, %d, SEEK_SET) == -1) {
7124 exit (EXIT_FAILURE);
7126 if (write (fd, &c, 1) == -1) {
7130 exit (EXIT_FAILURE);
7132 if (close (fd) == -1) {
7135 exit (EXIT_FAILURE);
7137 if (guestfs_add_drive (g, filename) == -1) {
7138 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7139 exit (EXIT_FAILURE);
7142 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
7143 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
7144 exit (EXIT_FAILURE);
7147 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
7150 if (guestfs_launch (g) == -1) {
7151 printf (\"guestfs_launch FAILED\\n\");
7152 exit (EXIT_FAILURE);
7155 /* Cancel previous alarm. */
7160 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
7164 pr " test_num++;\n";
7165 pr " if (guestfs_get_verbose (g))\n";
7166 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
7167 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
7168 pr " if (%s () == -1) {\n" test_name;
7169 pr " printf (\"%s FAILED\\n\");\n" test_name;
7170 pr " n_failed++;\n";
7175 pr " /* Check close callback is called. */
7176 int close_sentinel = 1;
7177 guestfs_set_close_callback (g, incr, &close_sentinel);
7181 if (close_sentinel != 2) {
7182 fprintf (stderr, \"close callback was not called\\n\");
7183 exit (EXIT_FAILURE);
7186 unlink (\"test1.img\");
7187 unlink (\"test2.img\");
7188 unlink (\"test3.img\");
7192 pr " if (n_failed > 0) {\n";
7193 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
7194 pr " exit (EXIT_FAILURE);\n";
7198 pr " exit (EXIT_SUCCESS);\n";
7201 and generate_one_test name flags i (init, prereq, test) =
7202 let test_name = sprintf "test_%s_%d" name i in
7205 static int %s_skip (void)
7209 str = getenv (\"TEST_ONLY\");
7211 return strstr (str, \"%s\") == NULL;
7212 str = getenv (\"SKIP_%s\");
7213 if (str && STREQ (str, \"1\")) return 1;
7214 str = getenv (\"SKIP_TEST_%s\");
7215 if (str && STREQ (str, \"1\")) return 1;
7219 " test_name name (String.uppercase test_name) (String.uppercase name);
7222 | Disabled | Always | IfAvailable _ -> ()
7223 | If code | Unless code ->
7224 pr "static int %s_prereq (void)\n" test_name;
7232 static int %s (void)
7235 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
7239 " test_name test_name test_name;
7241 (* Optional functions should only be tested if the relevant
7242 * support is available in the daemon.
7247 pr " if (!is_available (\"%s\")) {\n" group;
7248 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", \"%s\");\n" test_name group;
7256 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7258 pr " if (! %s_prereq ()) {\n" test_name;
7259 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7263 generate_one_test_body name i test_name init test;
7265 pr " if (%s_prereq ()) {\n" test_name;
7266 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7270 generate_one_test_body name i test_name init test;
7271 | IfAvailable group ->
7272 pr " if (!is_available (\"%s\")) {\n" group;
7273 pr " printf (\" %%s skipped (reason: %%s not available)\\n\", \"%s\", \"%s\");\n" test_name group;
7277 generate_one_test_body name i test_name init test;
7279 generate_one_test_body name i test_name init test
7287 and generate_one_test_body name i test_name init test =
7289 | InitNone (* XXX at some point, InitNone and InitEmpty became
7290 * folded together as the same thing. Really we should
7291 * make InitNone do nothing at all, but the tests may
7292 * need to be checked to make sure this is OK.
7295 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7296 List.iter (generate_test_command_call test_name)
7297 [["blockdev_setrw"; "/dev/sda"];
7301 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7302 List.iter (generate_test_command_call test_name)
7303 [["blockdev_setrw"; "/dev/sda"];
7306 ["part_disk"; "/dev/sda"; "mbr"]]
7308 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7309 List.iter (generate_test_command_call test_name)
7310 [["blockdev_setrw"; "/dev/sda"];
7313 ["part_disk"; "/dev/sda"; "mbr"];
7314 ["mkfs"; "ext2"; "/dev/sda1"];
7315 ["mount_options"; ""; "/dev/sda1"; "/"]]
7316 | InitBasicFSonLVM ->
7317 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7319 List.iter (generate_test_command_call test_name)
7320 [["blockdev_setrw"; "/dev/sda"];
7323 ["part_disk"; "/dev/sda"; "mbr"];
7324 ["pvcreate"; "/dev/sda1"];
7325 ["vgcreate"; "VG"; "/dev/sda1"];
7326 ["lvcreate"; "LV"; "VG"; "8"];
7327 ["mkfs"; "ext2"; "/dev/VG/LV"];
7328 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7330 pr " /* InitISOFS for %s */\n" test_name;
7331 List.iter (generate_test_command_call test_name)
7332 [["blockdev_setrw"; "/dev/sda"];
7335 ["mount_ro"; "/dev/sdd"; "/"]]
7338 let get_seq_last = function
7340 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7343 let seq = List.rev seq in
7344 List.rev (List.tl seq), List.hd seq
7349 pr " /* TestRun for %s (%d) */\n" name i;
7350 List.iter (generate_test_command_call test_name) seq
7351 | TestOutput (seq, expected) ->
7352 pr " /* TestOutput for %s (%d) */\n" name i;
7353 pr " const char *expected = \"%s\";\n" (c_quote expected);
7354 let seq, last = get_seq_last seq in
7356 pr " if (STRNEQ (r, expected)) {\n";
7357 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7361 List.iter (generate_test_command_call test_name) seq;
7362 generate_test_command_call ~test test_name last
7363 | TestOutputList (seq, expected) ->
7364 pr " /* TestOutputList for %s (%d) */\n" name i;
7365 let seq, last = get_seq_last seq in
7369 pr " if (!r[%d]) {\n" i;
7370 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7371 pr " print_strings (r);\n";
7375 pr " const char *expected = \"%s\";\n" (c_quote str);
7376 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7377 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7382 pr " if (r[%d] != NULL) {\n" (List.length expected);
7383 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7385 pr " print_strings (r);\n";
7389 List.iter (generate_test_command_call test_name) seq;
7390 generate_test_command_call ~test test_name last
7391 | TestOutputListOfDevices (seq, expected) ->
7392 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7393 let seq, last = get_seq_last seq in
7397 pr " if (!r[%d]) {\n" i;
7398 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7399 pr " print_strings (r);\n";
7403 pr " const char *expected = \"%s\";\n" (c_quote str);
7404 pr " r[%d][5] = 's';\n" i;
7405 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7406 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7411 pr " if (r[%d] != NULL) {\n" (List.length expected);
7412 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7414 pr " print_strings (r);\n";
7418 List.iter (generate_test_command_call test_name) seq;
7419 generate_test_command_call ~test test_name last
7420 | TestOutputInt (seq, expected) ->
7421 pr " /* TestOutputInt for %s (%d) */\n" name i;
7422 let seq, last = get_seq_last seq in
7424 pr " if (r != %d) {\n" expected;
7425 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7431 List.iter (generate_test_command_call test_name) seq;
7432 generate_test_command_call ~test test_name last
7433 | TestOutputIntOp (seq, op, expected) ->
7434 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7435 let seq, last = get_seq_last seq in
7437 pr " if (! (r %s %d)) {\n" op expected;
7438 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7439 test_name op expected;
7444 List.iter (generate_test_command_call test_name) seq;
7445 generate_test_command_call ~test test_name last
7446 | TestOutputTrue seq ->
7447 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7448 let seq, last = get_seq_last seq in
7451 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7456 List.iter (generate_test_command_call test_name) seq;
7457 generate_test_command_call ~test test_name last
7458 | TestOutputFalse seq ->
7459 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7460 let seq, last = get_seq_last seq in
7463 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7468 List.iter (generate_test_command_call test_name) seq;
7469 generate_test_command_call ~test test_name last
7470 | TestOutputLength (seq, expected) ->
7471 pr " /* TestOutputLength for %s (%d) */\n" name i;
7472 let seq, last = get_seq_last seq in
7475 pr " for (j = 0; j < %d; ++j)\n" expected;
7476 pr " if (r[j] == NULL) {\n";
7477 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7479 pr " print_strings (r);\n";
7482 pr " if (r[j] != NULL) {\n";
7483 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7485 pr " print_strings (r);\n";
7489 List.iter (generate_test_command_call test_name) seq;
7490 generate_test_command_call ~test test_name last
7491 | TestOutputBuffer (seq, expected) ->
7492 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7493 pr " const char *expected = \"%s\";\n" (c_quote expected);
7494 let seq, last = get_seq_last seq in
7495 let len = String.length expected in
7497 pr " if (size != %d) {\n" len;
7498 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7501 pr " if (STRNEQLEN (r, expected, size)) {\n";
7502 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7506 List.iter (generate_test_command_call test_name) seq;
7507 generate_test_command_call ~test test_name last
7508 | TestOutputStruct (seq, checks) ->
7509 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7510 let seq, last = get_seq_last seq in
7514 | CompareWithInt (field, expected) ->
7515 pr " if (r->%s != %d) {\n" field expected;
7516 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7517 test_name field expected;
7518 pr " (int) r->%s);\n" field;
7521 | CompareWithIntOp (field, op, expected) ->
7522 pr " if (!(r->%s %s %d)) {\n" field op expected;
7523 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7524 test_name field op expected;
7525 pr " (int) r->%s);\n" field;
7528 | CompareWithString (field, expected) ->
7529 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7530 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7531 test_name field expected;
7532 pr " r->%s);\n" field;
7535 | CompareFieldsIntEq (field1, field2) ->
7536 pr " if (r->%s != r->%s) {\n" field1 field2;
7537 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7538 test_name field1 field2;
7539 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7542 | CompareFieldsStrEq (field1, field2) ->
7543 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7544 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7545 test_name field1 field2;
7546 pr " r->%s, r->%s);\n" field1 field2;
7551 List.iter (generate_test_command_call test_name) seq;
7552 generate_test_command_call ~test test_name last
7553 | TestLastFail seq ->
7554 pr " /* TestLastFail for %s (%d) */\n" name i;
7555 let seq, last = get_seq_last seq in
7556 List.iter (generate_test_command_call test_name) seq;
7557 generate_test_command_call test_name ~expect_error:true last
7559 (* Generate the code to run a command, leaving the result in 'r'.
7560 * If you expect to get an error then you should set expect_error:true.
7562 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7564 | [] -> assert false
7566 (* Look up the command to find out what args/ret it has. *)
7569 let _, style, _, _, _, _, _ =
7570 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7573 failwithf "%s: in test, command %s was not found" test_name name in
7575 if List.length (snd style) <> List.length args then
7576 failwithf "%s: in test, wrong number of args given to %s"
7583 | OptString n, "NULL" -> ()
7586 | Dev_or_Path n, arg
7590 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7591 | BufferIn n, arg ->
7592 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7593 pr " size_t %s_size = %d;\n" n (String.length arg)
7597 | FileIn _, _ | FileOut _, _ -> ()
7598 | StringList n, "" | DeviceList n, "" ->
7599 pr " const char *const %s[1] = { NULL };\n" n
7600 | StringList n, arg | DeviceList n, arg ->
7601 let strs = string_split " " arg in
7604 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7606 pr " const char *const %s[] = {\n" n;
7608 fun i _ -> pr " %s_%d,\n" n i
7612 ) (List.combine (snd style) args);
7615 match fst style with
7616 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7617 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7618 | RConstString _ | RConstOptString _ ->
7619 pr " const char *r;\n"; "NULL"
7620 | RString _ -> pr " char *r;\n"; "NULL"
7621 | RStringList _ | RHashtable _ ->
7625 | RStruct (_, typ) ->
7626 pr " struct guestfs_%s *r;\n" typ; "NULL"
7627 | RStructList (_, typ) ->
7628 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7631 pr " size_t size;\n";
7634 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7635 pr " r = guestfs_%s (g" name;
7637 (* Generate the parameters. *)
7640 | OptString _, "NULL" -> pr ", NULL"
7642 | Device n, _ | Dev_or_Path n, _
7648 pr ", %s, %s_size" n n
7649 | FileIn _, arg | FileOut _, arg ->
7650 pr ", \"%s\"" (c_quote arg)
7651 | StringList n, _ | DeviceList n, _ ->
7652 pr ", (char **) %s" n
7655 try int_of_string arg
7656 with Failure "int_of_string" ->
7657 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7661 try Int64.of_string arg
7662 with Failure "int_of_string" ->
7663 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7666 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7667 ) (List.combine (snd style) args);
7669 (match fst style with
7670 | RBufferOut _ -> pr ", &size"
7676 if not expect_error then
7677 pr " if (r == %s)\n" error_code
7679 pr " if (r != %s)\n" error_code;
7682 (* Insert the test code. *)
7688 (match fst style with
7689 | RErr | RInt _ | RInt64 _ | RBool _
7690 | RConstString _ | RConstOptString _ -> ()
7691 | RString _ | RBufferOut _ -> pr " free (r);\n"
7692 | RStringList _ | RHashtable _ ->
7693 pr " for (i = 0; r[i] != NULL; ++i)\n";
7694 pr " free (r[i]);\n";
7696 | RStruct (_, typ) ->
7697 pr " guestfs_free_%s (r);\n" typ
7698 | RStructList (_, typ) ->
7699 pr " guestfs_free_%s_list (r);\n" typ
7705 let str = replace_str str "\r" "\\r" in
7706 let str = replace_str str "\n" "\\n" in
7707 let str = replace_str str "\t" "\\t" in
7708 let str = replace_str str "\000" "\\0" in
7711 (* Generate a lot of different functions for guestfish. *)
7712 and generate_fish_cmds () =
7713 generate_header CStyle GPLv2plus;
7717 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7719 let all_functions_sorted =
7721 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7722 ) all_functions_sorted in
7724 pr "#include <config.h>\n";
7726 pr "#include <stdio.h>\n";
7727 pr "#include <stdlib.h>\n";
7728 pr "#include <string.h>\n";
7729 pr "#include <inttypes.h>\n";
7731 pr "#include <guestfs.h>\n";
7732 pr "#include \"c-ctype.h\"\n";
7733 pr "#include \"full-write.h\"\n";
7734 pr "#include \"xstrtol.h\"\n";
7735 pr "#include \"fish.h\"\n";
7737 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7738 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7741 (* list_commands function, which implements guestfish -h *)
7742 pr "void list_commands (void)\n";
7744 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7745 pr " list_builtin_commands ();\n";
7747 fun (name, _, _, flags, _, shortdesc, _) ->
7748 let name = replace_char name '_' '-' in
7749 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7751 ) all_functions_sorted;
7752 pr " printf (\" %%s\\n\",";
7753 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7757 (* display_command function, which implements guestfish -h cmd *)
7758 pr "int display_command (const char *cmd)\n";
7761 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7762 let name2 = replace_char name '_' '-' in
7764 try find_map (function FishAlias n -> Some n | _ -> None) flags
7765 with Not_found -> name in
7766 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7768 match snd style with
7771 let args = List.filter (function Key _ -> false | _ -> true) args in
7773 name2 (String.concat " " (List.map name_of_argt args)) in
7776 if List.exists (function Key _ -> true | _ -> false) (snd style) then
7777 "\n\nThis command has one or more key or passphrase parameters.
7778 Guestfish will prompt for these separately."
7783 if List.mem ProtocolLimitWarning flags then
7784 ("\n\n" ^ protocol_limit_warning)
7787 (* For DangerWillRobinson commands, we should probably have
7788 * guestfish prompt before allowing you to use them (especially
7789 * in interactive mode). XXX
7793 if List.mem DangerWillRobinson flags then
7794 ("\n\n" ^ danger_will_robinson)
7799 match deprecation_notice flags with
7801 | Some txt -> "\n\n" ^ txt in
7803 let describe_alias =
7804 if name <> alias then
7805 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7809 pr "STRCASEEQ (cmd, \"%s\")" name;
7810 if name <> name2 then
7811 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7812 if name <> alias then
7813 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7815 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7817 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7818 "=head1 DESCRIPTION\n\n" ^
7819 longdesc ^ warnings ^ describe_alias);
7824 pr " return display_builtin_command (cmd);\n";
7828 let emit_print_list_function typ =
7829 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7832 pr " unsigned int i;\n";
7834 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7835 pr " printf (\"[%%d] = {\\n\", i);\n";
7836 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7837 pr " printf (\"}\\n\");\n";
7843 (* print_* functions *)
7847 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7849 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7852 pr " unsigned int i;\n";
7858 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7860 pr " printf (\"%%s%s: \", indent);\n" name;
7861 pr " for (i = 0; i < 32; ++i)\n";
7862 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7863 pr " printf (\"\\n\");\n"
7865 pr " printf (\"%%s%s: \", indent);\n" name;
7866 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7867 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7868 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7870 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7871 pr " printf (\"\\n\");\n"
7872 | name, (FUInt64|FBytes) ->
7873 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7876 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7879 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7882 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7885 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7887 | name, FOptPercent ->
7888 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7889 typ name name typ name;
7890 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7896 (* Emit a print_TYPE_list function definition only if that function is used. *)
7899 | typ, (RStructListOnly | RStructAndList) ->
7900 (* generate the function for typ *)
7901 emit_print_list_function typ
7902 | typ, _ -> () (* empty *)
7903 ) (rstructs_used_by all_functions);
7905 (* Emit a print_TYPE function definition only if that function is used. *)
7908 | typ, (RStructOnly | RStructAndList) ->
7909 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7911 pr " print_%s_indent (%s, \"\");\n" typ typ;
7914 | typ, _ -> () (* empty *)
7915 ) (rstructs_used_by all_functions);
7917 (* run_<action> actions *)
7919 fun (name, style, _, flags, _, _, _) ->
7920 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7922 (match fst style with
7925 | RBool _ -> pr " int r;\n"
7926 | RInt64 _ -> pr " int64_t r;\n"
7927 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7928 | RString _ -> pr " char *r;\n"
7929 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7930 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7931 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7934 pr " size_t size;\n";
7940 | OptString n -> pr " const char *%s;\n" n
7945 | Key n -> pr " char *%s;\n" n
7947 pr " const char *%s;\n" n;
7948 pr " size_t %s_size;\n" n
7949 | StringList n | DeviceList n -> pr " char **%s;\n" n
7950 | Bool n -> pr " int %s;\n" n
7951 | Int n -> pr " int %s;\n" n
7952 | Int64 n -> pr " int64_t %s;\n" n
7955 (* Check and convert parameters. *)
7958 List.filter (function Key _ -> false | _ -> true) (snd style) in
7959 List.length args_no_keys in
7960 pr " if (argc != %d) {\n" argc_expected;
7961 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7963 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7967 let parse_integer fn fntyp rtyp range name =
7969 pr " strtol_error xerr;\n";
7970 pr " %s r;\n" fntyp;
7972 pr " xerr = %s (argv[i++], NULL, 0, &r, xstrtol_suffixes);\n" fn;
7973 pr " if (xerr != LONGINT_OK) {\n";
7974 pr " fprintf (stderr,\n";
7975 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7976 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7981 | Some (min, max, comment) ->
7982 pr " /* %s */\n" comment;
7983 pr " if (r < %s || r > %s) {\n" min max;
7984 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7988 pr " /* The check above should ensure this assignment does not overflow. */\n";
7990 pr " %s = r;\n" name;
7994 if snd style <> [] then
7995 pr " size_t i = 0;\n";
8001 pr " %s = argv[i++];\n" name
8003 | Dev_or_Path name ->
8004 pr " %s = resolve_win_path (argv[i++]);\n" name;
8005 pr " if (%s == NULL) return -1;\n" name
8007 pr " %s = STRNEQ (argv[i], \"\") ? argv[i] : NULL;\n" name;
8010 pr " %s = argv[i];\n" name;
8011 pr " %s_size = strlen (argv[i]);\n" name;
8014 pr " %s = file_in (argv[i++]);\n" name;
8015 pr " if (%s == NULL) return -1;\n" name
8017 pr " %s = file_out (argv[i++]);\n" name;
8018 pr " if (%s == NULL) return -1;\n" name
8019 | StringList name | DeviceList name ->
8020 pr " %s = parse_string_list (argv[i++]);\n" name;
8021 pr " if (%s == NULL) return -1;\n" name
8023 pr " %s = read_key (\"%s\");\n" name name;
8024 pr " if (%s == NULL) return -1;\n" name
8026 pr " %s = is_true (argv[i++]) ? 1 : 0;\n" name
8029 let min = "(-(2LL<<30))"
8030 and max = "((2LL<<30)-1)"
8032 "The Int type in the generator is a signed 31 bit int." in
8033 Some (min, max, comment) in
8034 parse_integer "xstrtoll" "long long" "int" range name
8036 parse_integer "xstrtoll" "long long" "int64_t" None name
8039 (* Call C API function. *)
8040 pr " r = guestfs_%s " name;
8041 generate_c_call_args ~handle:"g" style;
8046 | Device _ | String _
8047 | OptString _ | Bool _
8050 | Pathname name | Dev_or_Path name | FileOut name
8052 pr " free (%s);\n" name
8054 pr " free_file_in (%s);\n" name
8055 | StringList name | DeviceList name ->
8056 pr " free_strings (%s);\n" name
8059 (* Any output flags? *)
8061 let flags = filter_map (
8062 function FishOutput flag -> Some flag | _ -> None
8068 failwithf "%s: more than one FishOutput flag is not allowed" name in
8070 (* Check return value for errors and display command results. *)
8071 (match fst style with
8072 | RErr -> pr " return r;\n"
8074 pr " if (r == -1) return -1;\n";
8075 (match fish_output with
8077 pr " printf (\"%%d\\n\", r);\n";
8078 | Some FishOutputOctal ->
8079 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
8080 | Some FishOutputHexadecimal ->
8081 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
8084 pr " if (r == -1) return -1;\n";
8085 (match fish_output with
8087 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
8088 | Some FishOutputOctal ->
8089 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
8090 | Some FishOutputHexadecimal ->
8091 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
8094 pr " if (r == -1) return -1;\n";
8095 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
8098 pr " if (r == NULL) return -1;\n";
8099 pr " printf (\"%%s\\n\", r);\n";
8101 | RConstOptString _ ->
8102 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
8105 pr " if (r == NULL) return -1;\n";
8106 pr " printf (\"%%s\\n\", r);\n";
8110 pr " if (r == NULL) return -1;\n";
8111 pr " print_strings (r);\n";
8112 pr " free_strings (r);\n";
8114 | RStruct (_, typ) ->
8115 pr " if (r == NULL) return -1;\n";
8116 pr " print_%s (r);\n" typ;
8117 pr " guestfs_free_%s (r);\n" typ;
8119 | RStructList (_, typ) ->
8120 pr " if (r == NULL) return -1;\n";
8121 pr " print_%s_list (r);\n" typ;
8122 pr " guestfs_free_%s_list (r);\n" typ;
8125 pr " if (r == NULL) return -1;\n";
8126 pr " print_table (r);\n";
8127 pr " free_strings (r);\n";
8130 pr " if (r == NULL) return -1;\n";
8131 pr " if (full_write (1, r, size) != size) {\n";
8132 pr " perror (\"write\");\n";
8143 (* run_action function *)
8144 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
8147 fun (name, _, _, flags, _, _, _) ->
8148 let name2 = replace_char name '_' '-' in
8150 try find_map (function FishAlias n -> Some n | _ -> None) flags
8151 with Not_found -> name in
8153 pr "STRCASEEQ (cmd, \"%s\")" name;
8154 if name <> name2 then
8155 pr " || STRCASEEQ (cmd, \"%s\")" name2;
8156 if name <> alias then
8157 pr " || STRCASEEQ (cmd, \"%s\")" alias;
8159 pr " return run_%s (cmd, argc, argv);\n" name;
8163 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
8164 pr " if (command_num == 1)\n";
8165 pr " extended_help_message ();\n";
8172 (* Readline completion for guestfish. *)
8173 and generate_fish_completion () =
8174 generate_header CStyle GPLv2plus;
8178 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8188 #ifdef HAVE_LIBREADLINE
8189 #include <readline/readline.h>
8194 #ifdef HAVE_LIBREADLINE
8196 static const char *const commands[] = {
8197 BUILTIN_COMMANDS_FOR_COMPLETION,
8200 (* Get the commands, including the aliases. They don't need to be
8201 * sorted - the generator() function just does a dumb linear search.
8205 fun (name, _, _, flags, _, _, _) ->
8206 let name2 = replace_char name '_' '-' in
8208 try find_map (function FishAlias n -> Some n | _ -> None) flags
8209 with Not_found -> name in
8211 if name <> alias then [name2; alias] else [name2]
8213 let commands = List.flatten commands in
8215 List.iter (pr " \"%s\",\n") commands;
8221 generator (const char *text, int state)
8223 static size_t index, len;
8228 len = strlen (text);
8231 rl_attempted_completion_over = 1;
8233 while ((name = commands[index]) != NULL) {
8235 if (STRCASEEQLEN (name, text, len))
8236 return strdup (name);
8242 #endif /* HAVE_LIBREADLINE */
8244 #ifdef HAVE_RL_COMPLETION_MATCHES
8245 #define RL_COMPLETION_MATCHES rl_completion_matches
8247 #ifdef HAVE_COMPLETION_MATCHES
8248 #define RL_COMPLETION_MATCHES completion_matches
8250 #endif /* else just fail if we don't have either symbol */
8253 do_completion (const char *text, int start, int end)
8255 char **matches = NULL;
8257 #ifdef HAVE_LIBREADLINE
8258 rl_completion_append_character = ' ';
8261 matches = RL_COMPLETION_MATCHES (text, generator);
8262 else if (complete_dest_paths)
8263 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
8270 (* Generate the POD documentation for guestfish. *)
8271 and generate_fish_actions_pod () =
8272 let all_functions_sorted =
8274 fun (_, _, _, flags, _, _, _) ->
8275 not (List.mem NotInFish flags || List.mem NotInDocs flags)
8276 ) all_functions_sorted in
8278 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8281 fun (name, style, _, flags, _, _, longdesc) ->
8283 Str.global_substitute rex (
8286 try Str.matched_group 1 s
8288 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8289 "C<" ^ replace_char sub '_' '-' ^ ">"
8291 let name = replace_char name '_' '-' in
8293 try find_map (function FishAlias n -> Some n | _ -> None) flags
8294 with Not_found -> name in
8296 pr "=head2 %s" name;
8297 if name <> alias then
8304 | Pathname n | Device n | Dev_or_Path n | String n ->
8306 | OptString n -> pr " %s" n
8307 | StringList n | DeviceList n -> pr " '%s ...'" n
8308 | Bool _ -> pr " true|false"
8309 | Int n -> pr " %s" n
8310 | Int64 n -> pr " %s" n
8311 | FileIn n | FileOut n -> pr " (%s|-)" n
8312 | BufferIn n -> pr " %s" n
8313 | Key _ -> () (* keys are entered at a prompt *)
8317 pr "%s\n\n" longdesc;
8319 if List.exists (function FileIn _ | FileOut _ -> true
8320 | _ -> false) (snd style) then
8321 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8323 if List.exists (function Key _ -> true | _ -> false) (snd style) then
8324 pr "This command has one or more key or passphrase parameters.
8325 Guestfish will prompt for these separately.\n\n";
8327 if List.mem ProtocolLimitWarning flags then
8328 pr "%s\n\n" protocol_limit_warning;
8330 if List.mem DangerWillRobinson flags then
8331 pr "%s\n\n" danger_will_robinson;
8333 match deprecation_notice flags with
8335 | Some txt -> pr "%s\n\n" txt
8336 ) all_functions_sorted
8338 (* Generate a C function prototype. *)
8339 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8340 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8342 ?handle name style =
8343 if extern then pr "extern ";
8344 if static then pr "static ";
8345 (match fst style with
8347 | RInt _ -> pr "int "
8348 | RInt64 _ -> pr "int64_t "
8349 | RBool _ -> pr "int "
8350 | RConstString _ | RConstOptString _ -> pr "const char *"
8351 | RString _ | RBufferOut _ -> pr "char *"
8352 | RStringList _ | RHashtable _ -> pr "char **"
8353 | RStruct (_, typ) ->
8354 if not in_daemon then pr "struct guestfs_%s *" typ
8355 else pr "guestfs_int_%s *" typ
8356 | RStructList (_, typ) ->
8357 if not in_daemon then pr "struct guestfs_%s_list *" typ
8358 else pr "guestfs_int_%s_list *" typ
8360 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8361 pr "%s%s (" prefix name;
8362 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8365 let comma = ref false in
8368 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8372 if single_line then pr ", " else pr ",\n\t\t"
8379 | Device n | Dev_or_Path n
8384 pr "const char *%s" n
8385 | StringList n | DeviceList n ->
8387 pr "char *const *%s" n
8388 | Bool n -> next (); pr "int %s" n
8389 | Int n -> next (); pr "int %s" n
8390 | Int64 n -> next (); pr "int64_t %s" n
8393 if not in_daemon then (next (); pr "const char *%s" n)
8396 pr "const char *%s" n;
8398 pr "size_t %s_size" n
8400 if is_RBufferOut then (next (); pr "size_t *size_r");
8403 if semicolon then pr ";";
8404 if newline then pr "\n"
8406 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8407 and generate_c_call_args ?handle ?(decl = false) style =
8409 let comma = ref false in
8411 if !comma then pr ", ";
8416 | Some handle -> pr "%s" handle; comma := true
8422 pr "%s, %s_size" n n
8425 pr "%s" (name_of_argt arg)
8427 (* For RBufferOut calls, add implicit &size parameter. *)
8429 match fst style with
8437 (* Generate the OCaml bindings interface. *)
8438 and generate_ocaml_mli () =
8439 generate_header OCamlStyle LGPLv2plus;
8442 (** For API documentation you should refer to the C API
8443 in the guestfs(3) manual page. The OCaml API uses almost
8444 exactly the same calls. *)
8447 (** A [guestfs_h] handle. *)
8449 exception Error of string
8450 (** This exception is raised when there is an error. *)
8452 exception Handle_closed of string
8453 (** This exception is raised if you use a {!Guestfs.t} handle
8454 after calling {!close} on it. The string is the name of
8457 val create : unit -> t
8458 (** Create a {!Guestfs.t} handle. *)
8460 val close : t -> unit
8461 (** Close the {!Guestfs.t} handle and free up all resources used
8464 Handles are closed by the garbage collector when they become
8465 unreferenced, but callers can call this in order to provide
8466 predictable cleanup. *)
8469 generate_ocaml_structure_decls ();
8473 fun (name, style, _, _, _, shortdesc, _) ->
8474 generate_ocaml_prototype name style;
8475 pr "(** %s *)\n" shortdesc;
8477 ) all_functions_sorted
8479 (* Generate the OCaml bindings implementation. *)
8480 and generate_ocaml_ml () =
8481 generate_header OCamlStyle LGPLv2plus;
8486 exception Error of string
8487 exception Handle_closed of string
8489 external create : unit -> t = \"ocaml_guestfs_create\"
8490 external close : t -> unit = \"ocaml_guestfs_close\"
8492 (* Give the exceptions names, so they can be raised from the C code. *)
8494 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8495 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8499 generate_ocaml_structure_decls ();
8503 fun (name, style, _, _, _, shortdesc, _) ->
8504 generate_ocaml_prototype ~is_external:true name style;
8505 ) all_functions_sorted
8507 (* Generate the OCaml bindings C implementation. *)
8508 and generate_ocaml_c () =
8509 generate_header CStyle LGPLv2plus;
8516 #include <caml/config.h>
8517 #include <caml/alloc.h>
8518 #include <caml/callback.h>
8519 #include <caml/fail.h>
8520 #include <caml/memory.h>
8521 #include <caml/mlvalues.h>
8522 #include <caml/signals.h>
8524 #include \"guestfs.h\"
8526 #include \"guestfs_c.h\"
8528 /* Copy a hashtable of string pairs into an assoc-list. We return
8529 * the list in reverse order, but hashtables aren't supposed to be
8532 static CAMLprim value
8533 copy_table (char * const * argv)
8536 CAMLlocal5 (rv, pairv, kv, vv, cons);
8540 for (i = 0; argv[i] != NULL; i += 2) {
8541 kv = caml_copy_string (argv[i]);
8542 vv = caml_copy_string (argv[i+1]);
8543 pairv = caml_alloc (2, 0);
8544 Store_field (pairv, 0, kv);
8545 Store_field (pairv, 1, vv);
8546 cons = caml_alloc (2, 0);
8547 Store_field (cons, 1, rv);
8549 Store_field (cons, 0, pairv);
8557 (* Struct copy functions. *)
8559 let emit_ocaml_copy_list_function typ =
8560 pr "static CAMLprim value\n";
8561 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8563 pr " CAMLparam0 ();\n";
8564 pr " CAMLlocal2 (rv, v);\n";
8565 pr " unsigned int i;\n";
8567 pr " if (%ss->len == 0)\n" typ;
8568 pr " CAMLreturn (Atom (0));\n";
8570 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8571 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8572 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8573 pr " caml_modify (&Field (rv, i), v);\n";
8575 pr " CAMLreturn (rv);\n";
8583 let has_optpercent_col =
8584 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8586 pr "static CAMLprim value\n";
8587 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8589 pr " CAMLparam0 ();\n";
8590 if has_optpercent_col then
8591 pr " CAMLlocal3 (rv, v, v2);\n"
8593 pr " CAMLlocal2 (rv, v);\n";
8595 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8600 pr " v = caml_copy_string (%s->%s);\n" typ name
8602 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8603 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8606 pr " v = caml_alloc_string (32);\n";
8607 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8608 | name, (FBytes|FInt64|FUInt64) ->
8609 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8610 | name, (FInt32|FUInt32) ->
8611 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8612 | name, FOptPercent ->
8613 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8614 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8615 pr " v = caml_alloc (1, 0);\n";
8616 pr " Store_field (v, 0, v2);\n";
8617 pr " } else /* None */\n";
8618 pr " v = Val_int (0);\n";
8620 pr " v = Val_int (%s->%s);\n" typ name
8622 pr " Store_field (rv, %d, v);\n" i
8624 pr " CAMLreturn (rv);\n";
8629 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8632 | typ, (RStructListOnly | RStructAndList) ->
8633 (* generate the function for typ *)
8634 emit_ocaml_copy_list_function typ
8635 | typ, _ -> () (* empty *)
8636 ) (rstructs_used_by all_functions);
8640 fun (name, style, _, _, _, _, _) ->
8641 pr "/* Automatically generated wrapper for function\n";
8643 generate_ocaml_prototype name style;
8648 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8650 let needs_extra_vs =
8651 match fst style with RConstOptString _ -> true | _ -> false in
8653 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8654 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8655 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8658 pr "CAMLprim value\n";
8659 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8660 List.iter (pr ", value %s") (List.tl params);
8665 | [p1; p2; p3; p4; p5] ->
8666 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8667 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8668 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8669 pr " CAMLxparam%d (%s);\n"
8670 (List.length rest) (String.concat ", " rest)
8672 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8674 if not needs_extra_vs then
8675 pr " CAMLlocal1 (rv);\n"
8677 pr " CAMLlocal3 (rv, v, v2);\n";
8680 pr " guestfs_h *g = Guestfs_val (gv);\n";
8681 pr " if (g == NULL)\n";
8682 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8688 | Device n | Dev_or_Path n
8693 (* Copy strings in case the GC moves them: RHBZ#604691 *)
8694 pr " char *%s = guestfs_safe_strdup (g, String_val (%sv));\n" n n
8696 pr " char *%s =\n" n;
8697 pr " %sv != Val_int (0) ?" n;
8698 pr " guestfs_safe_strdup (g, String_val (Field (%sv, 0))) : NULL;\n" n
8700 pr " size_t %s_size = caml_string_length (%sv);\n" n n;
8701 pr " char *%s = guestfs_safe_memdup (g, String_val (%sv), %s_size);\n" n n n
8702 | StringList n | DeviceList n ->
8703 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8705 pr " int %s = Bool_val (%sv);\n" n n
8707 pr " int %s = Int_val (%sv);\n" n n
8709 pr " int64_t %s = Int64_val (%sv);\n" n n
8712 match fst style with
8713 | RErr -> pr " int r;\n"; "-1"
8714 | RInt _ -> pr " int r;\n"; "-1"
8715 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8716 | RBool _ -> pr " int r;\n"; "-1"
8717 | RConstString _ | RConstOptString _ ->
8718 pr " const char *r;\n"; "NULL"
8719 | RString _ -> pr " char *r;\n"; "NULL"
8724 | RStruct (_, typ) ->
8725 pr " struct guestfs_%s *r;\n" typ; "NULL"
8726 | RStructList (_, typ) ->
8727 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8734 pr " size_t size;\n";
8738 pr " caml_enter_blocking_section ();\n";
8739 pr " r = guestfs_%s " name;
8740 generate_c_call_args ~handle:"g" style;
8742 pr " caml_leave_blocking_section ();\n";
8744 (* Free strings if we copied them above. *)
8747 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
8748 | FileIn n | FileOut n | BufferIn n | Key n ->
8749 pr " free (%s);\n" n
8750 | StringList n | DeviceList n ->
8751 pr " ocaml_guestfs_free_strings (%s);\n" n;
8752 | Bool _ | Int _ | Int64 _ -> ()
8755 pr " if (r == %s)\n" error_code;
8756 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8759 (match fst style with
8760 | RErr -> pr " rv = Val_unit;\n"
8761 | RInt _ -> pr " rv = Val_int (r);\n"
8763 pr " rv = caml_copy_int64 (r);\n"
8764 | RBool _ -> pr " rv = Val_bool (r);\n"
8766 pr " rv = caml_copy_string (r);\n"
8767 | RConstOptString _ ->
8768 pr " if (r) { /* Some string */\n";
8769 pr " v = caml_alloc (1, 0);\n";
8770 pr " v2 = caml_copy_string (r);\n";
8771 pr " Store_field (v, 0, v2);\n";
8772 pr " } else /* None */\n";
8773 pr " v = Val_int (0);\n";
8775 pr " rv = caml_copy_string (r);\n";
8778 pr " rv = caml_copy_string_array ((const char **) r);\n";
8779 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8781 | RStruct (_, typ) ->
8782 pr " rv = copy_%s (r);\n" typ;
8783 pr " guestfs_free_%s (r);\n" typ;
8784 | RStructList (_, typ) ->
8785 pr " rv = copy_%s_list (r);\n" typ;
8786 pr " guestfs_free_%s_list (r);\n" typ;
8788 pr " rv = copy_table (r);\n";
8789 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8792 pr " rv = caml_alloc_string (size);\n";
8793 pr " memcpy (String_val (rv), r, size);\n";
8796 pr " CAMLreturn (rv);\n";
8800 if List.length params > 5 then (
8801 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8802 pr "CAMLprim value ";
8803 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8804 pr "CAMLprim value\n";
8805 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8807 pr " return ocaml_guestfs_%s (argv[0]" name;
8808 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8813 ) all_functions_sorted
8815 and generate_ocaml_structure_decls () =
8818 pr "type %s = {\n" typ;
8821 | name, FString -> pr " %s : string;\n" name
8822 | name, FBuffer -> pr " %s : string;\n" name
8823 | name, FUUID -> pr " %s : string;\n" name
8824 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8825 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8826 | name, FChar -> pr " %s : char;\n" name
8827 | name, FOptPercent -> pr " %s : float option;\n" name
8833 and generate_ocaml_prototype ?(is_external = false) name style =
8834 if is_external then pr "external " else pr "val ";
8835 pr "%s : t -> " name;
8838 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8839 | BufferIn _ | Key _ -> pr "string -> "
8840 | OptString _ -> pr "string option -> "
8841 | StringList _ | DeviceList _ -> pr "string array -> "
8842 | Bool _ -> pr "bool -> "
8843 | Int _ -> pr "int -> "
8844 | Int64 _ -> pr "int64 -> "
8846 (match fst style with
8847 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8848 | RInt _ -> pr "int"
8849 | RInt64 _ -> pr "int64"
8850 | RBool _ -> pr "bool"
8851 | RConstString _ -> pr "string"
8852 | RConstOptString _ -> pr "string option"
8853 | RString _ | RBufferOut _ -> pr "string"
8854 | RStringList _ -> pr "string array"
8855 | RStruct (_, typ) -> pr "%s" typ
8856 | RStructList (_, typ) -> pr "%s array" typ
8857 | RHashtable _ -> pr "(string * string) list"
8859 if is_external then (
8861 if List.length (snd style) + 1 > 5 then
8862 pr "\"ocaml_guestfs_%s_byte\" " name;
8863 pr "\"ocaml_guestfs_%s\"" name
8867 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8868 and generate_perl_xs () =
8869 generate_header CStyle LGPLv2plus;
8872 #include \"EXTERN.h\"
8876 #include <guestfs.h>
8879 #define PRId64 \"lld\"
8883 my_newSVll(long long val) {
8884 #ifdef USE_64_BIT_ALL
8885 return newSViv(val);
8889 len = snprintf(buf, 100, \"%%\" PRId64, val);
8890 return newSVpv(buf, len);
8895 #define PRIu64 \"llu\"
8899 my_newSVull(unsigned long long val) {
8900 #ifdef USE_64_BIT_ALL
8901 return newSVuv(val);
8905 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8906 return newSVpv(buf, len);
8910 /* http://www.perlmonks.org/?node_id=680842 */
8912 XS_unpack_charPtrPtr (SV *arg) {
8917 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8918 croak (\"array reference expected\");
8920 av = (AV *)SvRV (arg);
8921 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8923 croak (\"malloc failed\");
8925 for (i = 0; i <= av_len (av); i++) {
8926 SV **elem = av_fetch (av, i, 0);
8928 if (!elem || !*elem)
8929 croak (\"missing element in list\");
8931 ret[i] = SvPV_nolen (*elem);
8939 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8946 RETVAL = guestfs_create ();
8948 croak (\"could not create guestfs handle\");
8949 guestfs_set_error_handler (RETVAL, NULL, NULL);
8957 /* For the 'g' argument above we do the conversion explicitly and
8958 * don't rely on the typemap, because if the handle has been
8959 * explicitly closed we don't want the typemap conversion to
8962 HV *hv = (HV *) SvRV (sv);
8963 SV **svp = hv_fetch (hv, \"_g\", 2, 0);
8965 guestfs_h *g = (guestfs_h *) SvIV (*svp);
8975 /* Avoid double-free in DESTROY method. */
8976 HV *hv = (HV *) SvRV (ST(0));
8977 (void) hv_delete (hv, \"_g\", 2, G_DISCARD);
8982 fun (name, style, _, _, _, _, _) ->
8983 (match fst style with
8984 | RErr -> pr "void\n"
8985 | RInt _ -> pr "SV *\n"
8986 | RInt64 _ -> pr "SV *\n"
8987 | RBool _ -> pr "SV *\n"
8988 | RConstString _ -> pr "SV *\n"
8989 | RConstOptString _ -> pr "SV *\n"
8990 | RString _ -> pr "SV *\n"
8991 | RBufferOut _ -> pr "SV *\n"
8993 | RStruct _ | RStructList _
8995 pr "void\n" (* all lists returned implictly on the stack *)
8997 (* Call and arguments. *)
9000 fun arg -> pr ", %s" (name_of_argt arg)
9003 pr " guestfs_h *g;\n";
9007 | Pathname n | Device n | Dev_or_Path n | String n
9008 | FileIn n | FileOut n | Key n ->
9011 pr " char *%s;\n" n;
9012 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
9014 (* http://www.perlmonks.org/?node_id=554277
9015 * Note that the implicit handle argument means we have
9016 * to add 1 to the ST(x) operator.
9018 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
9019 | StringList n | DeviceList n -> pr " char **%s;\n" n
9020 | Bool n -> pr " int %s;\n" n
9021 | Int n -> pr " int %s;\n" n
9022 | Int64 n -> pr " int64_t %s;\n" n
9025 let do_cleanups () =
9028 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
9029 | Bool _ | Int _ | Int64 _
9030 | FileIn _ | FileOut _
9031 | BufferIn _ | Key _ -> ()
9032 | StringList n | DeviceList n -> pr " free (%s);\n" n
9037 (match fst style with
9042 pr " r = guestfs_%s " name;
9043 generate_c_call_args ~handle:"g" style;
9046 pr " if (r == -1)\n";
9047 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9053 pr " %s = guestfs_%s " n name;
9054 generate_c_call_args ~handle:"g" style;
9057 pr " if (%s == -1)\n" n;
9058 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9059 pr " RETVAL = newSViv (%s);\n" n;
9064 pr " int64_t %s;\n" n;
9066 pr " %s = guestfs_%s " n name;
9067 generate_c_call_args ~handle:"g" style;
9070 pr " if (%s == -1)\n" n;
9071 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9072 pr " RETVAL = my_newSVll (%s);\n" n;
9077 pr " const char *%s;\n" n;
9079 pr " %s = guestfs_%s " n name;
9080 generate_c_call_args ~handle:"g" style;
9083 pr " if (%s == NULL)\n" n;
9084 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9085 pr " RETVAL = newSVpv (%s, 0);\n" n;
9088 | RConstOptString n ->
9090 pr " const char *%s;\n" n;
9092 pr " %s = guestfs_%s " n name;
9093 generate_c_call_args ~handle:"g" style;
9096 pr " if (%s == NULL)\n" n;
9097 pr " RETVAL = &PL_sv_undef;\n";
9099 pr " RETVAL = newSVpv (%s, 0);\n" n;
9104 pr " char *%s;\n" n;
9106 pr " %s = guestfs_%s " n name;
9107 generate_c_call_args ~handle:"g" style;
9110 pr " if (%s == NULL)\n" n;
9111 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9112 pr " RETVAL = newSVpv (%s, 0);\n" n;
9113 pr " free (%s);\n" n;
9116 | RStringList n | RHashtable n ->
9118 pr " char **%s;\n" n;
9119 pr " size_t i, n;\n";
9121 pr " %s = guestfs_%s " n name;
9122 generate_c_call_args ~handle:"g" style;
9125 pr " if (%s == NULL)\n" n;
9126 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9127 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
9128 pr " EXTEND (SP, n);\n";
9129 pr " for (i = 0; i < n; ++i) {\n";
9130 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
9131 pr " free (%s[i]);\n" n;
9133 pr " free (%s);\n" n;
9134 | RStruct (n, typ) ->
9135 let cols = cols_of_struct typ in
9136 generate_perl_struct_code typ cols name style n do_cleanups
9137 | RStructList (n, typ) ->
9138 let cols = cols_of_struct typ in
9139 generate_perl_struct_list_code typ cols name style n do_cleanups
9142 pr " char *%s;\n" n;
9143 pr " size_t size;\n";
9145 pr " %s = guestfs_%s " n name;
9146 generate_c_call_args ~handle:"g" style;
9149 pr " if (%s == NULL)\n" n;
9150 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9151 pr " RETVAL = newSVpvn (%s, size);\n" n;
9152 pr " free (%s);\n" n;
9160 and generate_perl_struct_list_code typ cols name style n do_cleanups =
9162 pr " struct guestfs_%s_list *%s;\n" typ n;
9166 pr " %s = guestfs_%s " n name;
9167 generate_c_call_args ~handle:"g" style;
9170 pr " if (%s == NULL)\n" n;
9171 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9172 pr " EXTEND (SP, %s->len);\n" n;
9173 pr " for (i = 0; i < %s->len; ++i) {\n" n;
9174 pr " hv = newHV ();\n";
9178 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
9179 name (String.length name) n name
9181 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
9182 name (String.length name) n name
9184 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
9185 name (String.length name) n name n name
9186 | name, (FBytes|FUInt64) ->
9187 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
9188 name (String.length name) n name
9190 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
9191 name (String.length name) n name
9192 | name, (FInt32|FUInt32) ->
9193 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9194 name (String.length name) n name
9196 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
9197 name (String.length name) n name
9198 | name, FOptPercent ->
9199 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9200 name (String.length name) n name
9202 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
9204 pr " guestfs_free_%s_list (%s);\n" typ n
9206 and generate_perl_struct_code typ cols name style n do_cleanups =
9208 pr " struct guestfs_%s *%s;\n" typ n;
9210 pr " %s = guestfs_%s " n name;
9211 generate_c_call_args ~handle:"g" style;
9214 pr " if (%s == NULL)\n" n;
9215 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9216 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
9218 fun ((name, _) as col) ->
9219 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
9223 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
9226 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
9229 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
9231 | name, (FBytes|FUInt64) ->
9232 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
9235 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
9237 | name, (FInt32|FUInt32) ->
9238 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9241 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
9243 | name, FOptPercent ->
9244 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9247 pr " free (%s);\n" n
9249 (* Generate Sys/Guestfs.pm. *)
9250 and generate_perl_pm () =
9251 generate_header HashStyle LGPLv2plus;
9258 Sys::Guestfs - Perl bindings for libguestfs
9264 my $h = Sys::Guestfs->new ();
9265 $h->add_drive ('guest.img');
9267 $h->mount ('/dev/sda1', '/');
9268 $h->touch ('/hello');
9273 The C<Sys::Guestfs> module provides a Perl XS binding to the
9274 libguestfs API for examining and modifying virtual machine
9277 Amongst the things this is good for: making batch configuration
9278 changes to guests, getting disk used/free statistics (see also:
9279 virt-df), migrating between virtualization systems (see also:
9280 virt-p2v), performing partial backups, performing partial guest
9281 clones, cloning guests and changing registry/UUID/hostname info, and
9284 Libguestfs uses Linux kernel and qemu code, and can access any type of
9285 guest filesystem that Linux and qemu can, including but not limited
9286 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9287 schemes, qcow, qcow2, vmdk.
9289 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9290 LVs, what filesystem is in each LV, etc.). It can also run commands
9291 in the context of the guest. Also you can access filesystems over
9294 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
9295 functions for using libguestfs from Perl, including integration
9300 All errors turn into calls to C<croak> (see L<Carp(3)>).
9308 package Sys::Guestfs;
9313 # This version number changes whenever a new function
9314 # is added to the libguestfs API. It is not directly
9315 # related to the libguestfs version number.
9316 use vars qw($VERSION);
9320 XSLoader::load ('Sys::Guestfs');
9322 =item $h = Sys::Guestfs->new ();
9324 Create a new guestfs handle.
9330 my $class = ref ($proto) || $proto;
9332 my $g = Sys::Guestfs::_create ();
9333 my $self = { _g => $g };
9334 bless $self, $class;
9340 Explicitly close the guestfs handle.
9342 B<Note:> You should not usually call this function. The handle will
9343 be closed implicitly when its reference count goes to zero (eg.
9344 when it goes out of scope or the program ends). This call is
9345 only required in some exceptional cases, such as where the program
9346 may contain cached references to the handle 'somewhere' and you
9347 really have to have the close happen right away. After calling
9348 C<close> the program must not call any method (including C<close>)
9349 on the handle (but the implicit call to C<DESTROY> that happens
9350 when the final reference is cleaned up is OK).
9356 (* Actions. We only need to print documentation for these as
9357 * they are pulled in from the XS code automatically.
9360 fun (name, style, _, flags, _, _, longdesc) ->
9361 if not (List.mem NotInDocs flags) then (
9362 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9364 generate_perl_prototype name style;
9366 pr "%s\n\n" longdesc;
9367 if List.mem ProtocolLimitWarning flags then
9368 pr "%s\n\n" protocol_limit_warning;
9369 if List.mem DangerWillRobinson flags then
9370 pr "%s\n\n" danger_will_robinson;
9371 match deprecation_notice flags with
9373 | Some txt -> pr "%s\n\n" txt
9375 ) all_functions_sorted;
9387 Copyright (C) %s Red Hat Inc.
9391 Please see the file COPYING.LIB for the full license.
9397 L<http://libguestfs.org>,
9398 L<Sys::Guestfs::Lib(3)>.
9403 and generate_perl_prototype name style =
9404 (match fst style with
9412 | RBufferOut n -> pr "$%s = " n
9414 | RHashtable n -> pr "%%%s = " n
9416 | RStructList (n,_) -> pr "@%s = " n
9419 let comma = ref false in
9422 if !comma then pr ", ";
9425 | Pathname n | Device n | Dev_or_Path n | String n
9426 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9427 | BufferIn n | Key n ->
9429 | StringList n | DeviceList n ->
9434 (* Generate Python C module. *)
9435 and generate_python_c () =
9436 generate_header CStyle LGPLv2plus;
9439 #define PY_SSIZE_T_CLEAN 1
9442 #if PY_VERSION_HEX < 0x02050000
9443 typedef int Py_ssize_t;
9444 #define PY_SSIZE_T_MAX INT_MAX
9445 #define PY_SSIZE_T_MIN INT_MIN
9452 #include \"guestfs.h\"
9460 get_handle (PyObject *obj)
9463 assert (obj != Py_None);
9464 return ((Pyguestfs_Object *) obj)->g;
9468 put_handle (guestfs_h *g)
9472 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9475 /* This list should be freed (but not the strings) after use. */
9477 get_string_list (PyObject *obj)
9484 if (!PyList_Check (obj)) {
9485 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9489 Py_ssize_t slen = PyList_Size (obj);
9491 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: PyList_Size failure\");
9494 len = (size_t) slen;
9495 r = malloc (sizeof (char *) * (len+1));
9497 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9501 for (i = 0; i < len; ++i)
9502 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9509 put_string_list (char * const * const argv)
9514 for (argc = 0; argv[argc] != NULL; ++argc)
9517 list = PyList_New (argc);
9518 for (i = 0; i < argc; ++i)
9519 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9525 put_table (char * const * const argv)
9527 PyObject *list, *item;
9530 for (argc = 0; argv[argc] != NULL; ++argc)
9533 list = PyList_New (argc >> 1);
9534 for (i = 0; i < argc; i += 2) {
9535 item = PyTuple_New (2);
9536 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9537 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9538 PyList_SetItem (list, i >> 1, item);
9545 free_strings (char **argv)
9549 for (argc = 0; argv[argc] != NULL; ++argc)
9555 py_guestfs_create (PyObject *self, PyObject *args)
9559 g = guestfs_create ();
9561 PyErr_SetString (PyExc_RuntimeError,
9562 \"guestfs.create: failed to allocate handle\");
9565 guestfs_set_error_handler (g, NULL, NULL);
9566 return put_handle (g);
9570 py_guestfs_close (PyObject *self, PyObject *args)
9575 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9577 g = get_handle (py_g);
9581 Py_INCREF (Py_None);
9587 let emit_put_list_function typ =
9588 pr "static PyObject *\n";
9589 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9591 pr " PyObject *list;\n";
9594 pr " list = PyList_New (%ss->len);\n" typ;
9595 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9596 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9597 pr " return list;\n";
9602 (* Structures, turned into Python dictionaries. *)
9605 pr "static PyObject *\n";
9606 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9608 pr " PyObject *dict;\n";
9610 pr " dict = PyDict_New ();\n";
9614 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9615 pr " PyString_FromString (%s->%s));\n"
9618 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9619 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9622 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9623 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9625 | name, (FBytes|FUInt64) ->
9626 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9627 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9630 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9631 pr " PyLong_FromLongLong (%s->%s));\n"
9634 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9635 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9638 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9639 pr " PyLong_FromLong (%s->%s));\n"
9641 | name, FOptPercent ->
9642 pr " if (%s->%s >= 0)\n" typ name;
9643 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9644 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9647 pr " Py_INCREF (Py_None);\n";
9648 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9651 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9652 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9654 pr " return dict;\n";
9660 (* Emit a put_TYPE_list function definition only if that function is used. *)
9663 | typ, (RStructListOnly | RStructAndList) ->
9664 (* generate the function for typ *)
9665 emit_put_list_function typ
9666 | typ, _ -> () (* empty *)
9667 ) (rstructs_used_by all_functions);
9669 (* Python wrapper functions. *)
9671 fun (name, style, _, _, _, _, _) ->
9672 pr "static PyObject *\n";
9673 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9676 pr " PyObject *py_g;\n";
9677 pr " guestfs_h *g;\n";
9678 pr " PyObject *py_r;\n";
9681 match fst style with
9682 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9683 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9684 | RConstString _ | RConstOptString _ ->
9685 pr " const char *r;\n"; "NULL"
9686 | RString _ -> pr " char *r;\n"; "NULL"
9687 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9688 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9689 | RStructList (_, typ) ->
9690 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9693 pr " size_t size;\n";
9698 | Pathname n | Device n | Dev_or_Path n | String n | Key n
9699 | FileIn n | FileOut n ->
9700 pr " const char *%s;\n" n
9701 | OptString n -> pr " const char *%s;\n" n
9703 pr " const char *%s;\n" n;
9704 pr " Py_ssize_t %s_size;\n" n
9705 | StringList n | DeviceList n ->
9706 pr " PyObject *py_%s;\n" n;
9707 pr " char **%s;\n" n
9708 | Bool n -> pr " int %s;\n" n
9709 | Int n -> pr " int %s;\n" n
9710 | Int64 n -> pr " long long %s;\n" n
9715 (* Convert the parameters. *)
9716 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9719 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
9720 | FileIn _ | FileOut _ -> pr "s"
9721 | OptString _ -> pr "z"
9722 | StringList _ | DeviceList _ -> pr "O"
9723 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9725 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9726 * emulate C's int/long/long long in Python?
9728 | BufferIn _ -> pr "s#"
9730 pr ":guestfs_%s\",\n" name;
9734 | Pathname n | Device n | Dev_or_Path n | String n | Key n
9735 | FileIn n | FileOut n -> pr ", &%s" n
9736 | OptString n -> pr ", &%s" n
9737 | StringList n | DeviceList n -> pr ", &py_%s" n
9738 | Bool n -> pr ", &%s" n
9739 | Int n -> pr ", &%s" n
9740 | Int64 n -> pr ", &%s" n
9741 | BufferIn n -> pr ", &%s, &%s_size" n n
9745 pr " return NULL;\n";
9747 pr " g = get_handle (py_g);\n";
9750 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
9751 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9753 | StringList n | DeviceList n ->
9754 pr " %s = get_string_list (py_%s);\n" n n;
9755 pr " if (!%s) return NULL;\n" n
9760 pr " r = guestfs_%s " name;
9761 generate_c_call_args ~handle:"g" style;
9766 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
9767 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9769 | StringList n | DeviceList n ->
9770 pr " free (%s);\n" n
9773 pr " if (r == %s) {\n" error_code;
9774 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9775 pr " return NULL;\n";
9779 (match fst style with
9781 pr " Py_INCREF (Py_None);\n";
9782 pr " py_r = Py_None;\n"
9784 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9785 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9786 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9787 | RConstOptString _ ->
9789 pr " py_r = PyString_FromString (r);\n";
9791 pr " Py_INCREF (Py_None);\n";
9792 pr " py_r = Py_None;\n";
9795 pr " py_r = PyString_FromString (r);\n";
9798 pr " py_r = put_string_list (r);\n";
9799 pr " free_strings (r);\n"
9800 | RStruct (_, typ) ->
9801 pr " py_r = put_%s (r);\n" typ;
9802 pr " guestfs_free_%s (r);\n" typ
9803 | RStructList (_, typ) ->
9804 pr " py_r = put_%s_list (r);\n" typ;
9805 pr " guestfs_free_%s_list (r);\n" typ
9807 pr " py_r = put_table (r);\n";
9808 pr " free_strings (r);\n"
9810 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9814 pr " return py_r;\n";
9819 (* Table of functions. *)
9820 pr "static PyMethodDef methods[] = {\n";
9821 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9822 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9824 fun (name, _, _, _, _, _, _) ->
9825 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9828 pr " { NULL, NULL, 0, NULL }\n";
9832 (* Init function. *)
9835 initlibguestfsmod (void)
9837 static int initialized = 0;
9839 if (initialized) return;
9840 Py_InitModule ((char *) \"libguestfsmod\", methods);
9845 (* Generate Python module. *)
9846 and generate_python_py () =
9847 generate_header HashStyle LGPLv2plus;
9850 u\"\"\"Python bindings for libguestfs
9853 g = guestfs.GuestFS ()
9854 g.add_drive (\"guest.img\")
9856 parts = g.list_partitions ()
9858 The guestfs module provides a Python binding to the libguestfs API
9859 for examining and modifying virtual machine disk images.
9861 Amongst the things this is good for: making batch configuration
9862 changes to guests, getting disk used/free statistics (see also:
9863 virt-df), migrating between virtualization systems (see also:
9864 virt-p2v), performing partial backups, performing partial guest
9865 clones, cloning guests and changing registry/UUID/hostname info, and
9868 Libguestfs uses Linux kernel and qemu code, and can access any type of
9869 guest filesystem that Linux and qemu can, including but not limited
9870 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9871 schemes, qcow, qcow2, vmdk.
9873 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9874 LVs, what filesystem is in each LV, etc.). It can also run commands
9875 in the context of the guest. Also you can access filesystems over
9878 Errors which happen while using the API are turned into Python
9879 RuntimeError exceptions.
9881 To create a guestfs handle you usually have to perform the following
9884 # Create the handle, call add_drive at least once, and possibly
9885 # several times if the guest has multiple block devices:
9886 g = guestfs.GuestFS ()
9887 g.add_drive (\"guest.img\")
9889 # Launch the qemu subprocess and wait for it to become ready:
9892 # Now you can issue commands, for example:
9897 import libguestfsmod
9900 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9902 def __init__ (self):
9903 \"\"\"Create a new libguestfs handle.\"\"\"
9904 self._o = libguestfsmod.create ()
9907 libguestfsmod.close (self._o)
9912 fun (name, style, _, flags, _, _, longdesc) ->
9914 generate_py_call_args ~handle:"self" (snd style);
9917 if not (List.mem NotInDocs flags) then (
9918 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9920 match fst style with
9921 | RErr | RInt _ | RInt64 _ | RBool _
9922 | RConstOptString _ | RConstString _
9923 | RString _ | RBufferOut _ -> doc
9925 doc ^ "\n\nThis function returns a list of strings."
9926 | RStruct (_, typ) ->
9927 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9928 | RStructList (_, typ) ->
9929 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9931 doc ^ "\n\nThis function returns a dictionary." in
9933 if List.mem ProtocolLimitWarning flags then
9934 doc ^ "\n\n" ^ protocol_limit_warning
9937 if List.mem DangerWillRobinson flags then
9938 doc ^ "\n\n" ^ danger_will_robinson
9941 match deprecation_notice flags with
9943 | Some txt -> doc ^ "\n\n" ^ txt in
9944 let doc = pod2text ~width:60 name doc in
9945 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9946 let doc = String.concat "\n " doc in
9947 pr " u\"\"\"%s\"\"\"\n" doc;
9949 pr " return libguestfsmod.%s " name;
9950 generate_py_call_args ~handle:"self._o" (snd style);
9955 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9956 and generate_py_call_args ~handle args =
9958 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9961 (* Useful if you need the longdesc POD text as plain text. Returns a
9964 * Because this is very slow (the slowest part of autogeneration),
9965 * we memoize the results.
9967 and pod2text ~width name longdesc =
9968 let key = width, name, longdesc in
9969 try Hashtbl.find pod2text_memo key
9971 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9972 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9974 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9975 let chan = open_process_in cmd in
9976 let lines = ref [] in
9978 let line = input_line chan in
9979 if i = 1 then (* discard the first line of output *)
9982 let line = triml line in
9983 lines := line :: !lines;
9986 let lines = try loop 1 with End_of_file -> List.rev !lines in
9988 (match close_process_in chan with
9991 failwithf "pod2text: process exited with non-zero status (%d)" i
9992 | WSIGNALED i | WSTOPPED i ->
9993 failwithf "pod2text: process signalled or stopped by signal %d" i
9995 Hashtbl.add pod2text_memo key lines;
9996 pod2text_memo_updated ();
9999 (* Generate ruby bindings. *)
10000 and generate_ruby_c () =
10001 generate_header CStyle LGPLv2plus;
10005 #include <stdlib.h>
10009 #include \"guestfs.h\"
10011 #include \"extconf.h\"
10013 /* For Ruby < 1.9 */
10015 #define RARRAY_LEN(r) (RARRAY((r))->len)
10018 static VALUE m_guestfs; /* guestfs module */
10019 static VALUE c_guestfs; /* guestfs_h handle */
10020 static VALUE e_Error; /* used for all errors */
10022 static void ruby_guestfs_free (void *p)
10025 guestfs_close ((guestfs_h *) p);
10028 static VALUE ruby_guestfs_create (VALUE m)
10032 g = guestfs_create ();
10034 rb_raise (e_Error, \"failed to create guestfs handle\");
10036 /* Don't print error messages to stderr by default. */
10037 guestfs_set_error_handler (g, NULL, NULL);
10039 /* Wrap it, and make sure the close function is called when the
10040 * handle goes away.
10042 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
10045 static VALUE ruby_guestfs_close (VALUE gv)
10048 Data_Get_Struct (gv, guestfs_h, g);
10050 ruby_guestfs_free (g);
10051 DATA_PTR (gv) = NULL;
10059 fun (name, style, _, _, _, _, _) ->
10060 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
10061 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
10064 pr " guestfs_h *g;\n";
10065 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
10067 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
10073 | Pathname n | Device n | Dev_or_Path n | String n | Key n
10074 | FileIn n | FileOut n ->
10075 pr " Check_Type (%sv, T_STRING);\n" n;
10076 pr " const char *%s = StringValueCStr (%sv);\n" n n;
10077 pr " if (!%s)\n" n;
10078 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
10079 pr " \"%s\", \"%s\");\n" n name
10081 pr " Check_Type (%sv, T_STRING);\n" n;
10082 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
10083 pr " if (!%s)\n" n;
10084 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
10085 pr " \"%s\", \"%s\");\n" n name;
10086 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
10088 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
10089 | StringList n | DeviceList n ->
10090 pr " char **%s;\n" n;
10091 pr " Check_Type (%sv, T_ARRAY);\n" n;
10093 pr " size_t i, len;\n";
10094 pr " len = RARRAY_LEN (%sv);\n" n;
10095 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
10097 pr " for (i = 0; i < len; ++i) {\n";
10098 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
10099 pr " %s[i] = StringValueCStr (v);\n" n;
10101 pr " %s[len] = NULL;\n" n;
10104 pr " int %s = RTEST (%sv);\n" n n
10106 pr " int %s = NUM2INT (%sv);\n" n n
10108 pr " long long %s = NUM2LL (%sv);\n" n n
10113 match fst style with
10114 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
10115 | RInt64 _ -> pr " int64_t r;\n"; "-1"
10116 | RConstString _ | RConstOptString _ ->
10117 pr " const char *r;\n"; "NULL"
10118 | RString _ -> pr " char *r;\n"; "NULL"
10119 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
10120 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
10121 | RStructList (_, typ) ->
10122 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
10125 pr " size_t size;\n";
10129 pr " r = guestfs_%s " name;
10130 generate_c_call_args ~handle:"g" style;
10135 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
10136 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
10138 | StringList n | DeviceList n ->
10139 pr " free (%s);\n" n
10142 pr " if (r == %s)\n" error_code;
10143 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
10146 (match fst style with
10148 pr " return Qnil;\n"
10149 | RInt _ | RBool _ ->
10150 pr " return INT2NUM (r);\n"
10152 pr " return ULL2NUM (r);\n"
10153 | RConstString _ ->
10154 pr " return rb_str_new2 (r);\n";
10155 | RConstOptString _ ->
10157 pr " return rb_str_new2 (r);\n";
10159 pr " return Qnil;\n";
10161 pr " VALUE rv = rb_str_new2 (r);\n";
10163 pr " return rv;\n";
10165 pr " size_t i, len = 0;\n";
10166 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
10167 pr " VALUE rv = rb_ary_new2 (len);\n";
10168 pr " for (i = 0; r[i] != NULL; ++i) {\n";
10169 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
10170 pr " free (r[i]);\n";
10174 | RStruct (_, typ) ->
10175 let cols = cols_of_struct typ in
10176 generate_ruby_struct_code typ cols
10177 | RStructList (_, typ) ->
10178 let cols = cols_of_struct typ in
10179 generate_ruby_struct_list_code typ cols
10181 pr " VALUE rv = rb_hash_new ();\n";
10183 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
10184 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
10185 pr " free (r[i]);\n";
10186 pr " free (r[i+1]);\n";
10191 pr " VALUE rv = rb_str_new (r, size);\n";
10193 pr " return rv;\n";
10201 /* Initialize the module. */
10202 void Init__guestfs ()
10204 m_guestfs = rb_define_module (\"Guestfs\");
10205 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
10206 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
10208 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
10209 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
10212 (* Define the rest of the methods. *)
10214 fun (name, style, _, _, _, _, _) ->
10215 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
10216 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
10221 (* Ruby code to return a struct. *)
10222 and generate_ruby_struct_code typ cols =
10223 pr " VALUE rv = rb_hash_new ();\n";
10227 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
10229 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
10231 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
10232 | name, (FBytes|FUInt64) ->
10233 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10235 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
10237 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
10239 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
10240 | name, FOptPercent ->
10241 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
10242 | name, FChar -> (* XXX wrong? *)
10243 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10245 pr " guestfs_free_%s (r);\n" typ;
10248 (* Ruby code to return a struct list. *)
10249 and generate_ruby_struct_list_code typ cols =
10250 pr " VALUE rv = rb_ary_new2 (r->len);\n";
10252 pr " for (i = 0; i < r->len; ++i) {\n";
10253 pr " VALUE hv = rb_hash_new ();\n";
10257 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
10259 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
10261 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
10262 | name, (FBytes|FUInt64) ->
10263 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10265 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
10267 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
10269 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
10270 | name, FOptPercent ->
10271 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
10272 | name, FChar -> (* XXX wrong? *)
10273 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10275 pr " rb_ary_push (rv, hv);\n";
10277 pr " guestfs_free_%s_list (r);\n" typ;
10280 (* Generate Java bindings GuestFS.java file. *)
10281 and generate_java_java () =
10282 generate_header CStyle LGPLv2plus;
10285 package com.redhat.et.libguestfs;
10287 import java.util.HashMap;
10288 import com.redhat.et.libguestfs.LibGuestFSException;
10289 import com.redhat.et.libguestfs.PV;
10290 import com.redhat.et.libguestfs.VG;
10291 import com.redhat.et.libguestfs.LV;
10292 import com.redhat.et.libguestfs.Stat;
10293 import com.redhat.et.libguestfs.StatVFS;
10294 import com.redhat.et.libguestfs.IntBool;
10295 import com.redhat.et.libguestfs.Dirent;
10298 * The GuestFS object is a libguestfs handle.
10302 public class GuestFS {
10303 // Load the native code.
10305 System.loadLibrary (\"guestfs_jni\");
10309 * The native guestfs_h pointer.
10314 * Create a libguestfs handle.
10316 * @throws LibGuestFSException
10318 public GuestFS () throws LibGuestFSException
10322 private native long _create () throws LibGuestFSException;
10325 * Close a libguestfs handle.
10327 * You can also leave handles to be collected by the garbage
10328 * collector, but this method ensures that the resources used
10329 * by the handle are freed up immediately. If you call any
10330 * other methods after closing the handle, you will get an
10333 * @throws LibGuestFSException
10335 public void close () throws LibGuestFSException
10341 private native void _close (long g) throws LibGuestFSException;
10343 public void finalize () throws LibGuestFSException
10351 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10352 if not (List.mem NotInDocs flags); then (
10353 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10355 if List.mem ProtocolLimitWarning flags then
10356 doc ^ "\n\n" ^ protocol_limit_warning
10359 if List.mem DangerWillRobinson flags then
10360 doc ^ "\n\n" ^ danger_will_robinson
10363 match deprecation_notice flags with
10365 | Some txt -> doc ^ "\n\n" ^ txt in
10366 let doc = pod2text ~width:60 name doc in
10367 let doc = List.map ( (* RHBZ#501883 *)
10370 | nonempty -> nonempty
10372 let doc = String.concat "\n * " doc in
10375 pr " * %s\n" shortdesc;
10378 pr " * @throws LibGuestFSException\n";
10382 generate_java_prototype ~public:true ~semicolon:false name style;
10385 pr " if (g == 0)\n";
10386 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10389 if fst style <> RErr then pr "return ";
10391 generate_java_call_args ~handle:"g" (snd style);
10395 generate_java_prototype ~privat:true ~native:true name style;
10402 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10403 and generate_java_call_args ~handle args =
10405 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10408 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10409 ?(semicolon=true) name style =
10410 if privat then pr "private ";
10411 if public then pr "public ";
10412 if native then pr "native ";
10415 (match fst style with
10416 | RErr -> pr "void ";
10417 | RInt _ -> pr "int ";
10418 | RInt64 _ -> pr "long ";
10419 | RBool _ -> pr "boolean ";
10420 | RConstString _ | RConstOptString _ | RString _
10421 | RBufferOut _ -> pr "String ";
10422 | RStringList _ -> pr "String[] ";
10423 | RStruct (_, typ) ->
10424 let name = java_name_of_struct typ in
10426 | RStructList (_, typ) ->
10427 let name = java_name_of_struct typ in
10429 | RHashtable _ -> pr "HashMap<String,String> ";
10432 if native then pr "_%s " name else pr "%s " name;
10434 let needs_comma = ref false in
10437 needs_comma := true
10443 if !needs_comma then pr ", ";
10444 needs_comma := true;
10448 | Device n | Dev_or_Path n
10457 | StringList n | DeviceList n ->
10468 pr " throws LibGuestFSException";
10469 if semicolon then pr ";"
10471 and generate_java_struct jtyp cols () =
10472 generate_header CStyle LGPLv2plus;
10475 package com.redhat.et.libguestfs;
10478 * Libguestfs %s structure.
10490 | name, FBuffer -> pr " public String %s;\n" name
10491 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10492 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10493 | name, FChar -> pr " public char %s;\n" name
10494 | name, FOptPercent ->
10495 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10496 pr " public float %s;\n" name
10501 and generate_java_c () =
10502 generate_header CStyle LGPLv2plus;
10506 #include <stdlib.h>
10507 #include <string.h>
10509 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10510 #include \"guestfs.h\"
10512 /* Note that this function returns. The exception is not thrown
10513 * until after the wrapper function returns.
10516 throw_exception (JNIEnv *env, const char *msg)
10519 cl = (*env)->FindClass (env,
10520 \"com/redhat/et/libguestfs/LibGuestFSException\");
10521 (*env)->ThrowNew (env, cl, msg);
10524 JNIEXPORT jlong JNICALL
10525 Java_com_redhat_et_libguestfs_GuestFS__1create
10526 (JNIEnv *env, jobject obj)
10530 g = guestfs_create ();
10532 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10535 guestfs_set_error_handler (g, NULL, NULL);
10536 return (jlong) (long) g;
10539 JNIEXPORT void JNICALL
10540 Java_com_redhat_et_libguestfs_GuestFS__1close
10541 (JNIEnv *env, jobject obj, jlong jg)
10543 guestfs_h *g = (guestfs_h *) (long) jg;
10550 fun (name, style, _, _, _, _, _) ->
10552 (match fst style with
10553 | RErr -> pr "void ";
10554 | RInt _ -> pr "jint ";
10555 | RInt64 _ -> pr "jlong ";
10556 | RBool _ -> pr "jboolean ";
10557 | RConstString _ | RConstOptString _ | RString _
10558 | RBufferOut _ -> pr "jstring ";
10559 | RStruct _ | RHashtable _ ->
10561 | RStringList _ | RStructList _ ->
10562 pr "jobjectArray ";
10565 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10566 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10568 pr " (JNIEnv *env, jobject obj, jlong jg";
10572 | Device n | Dev_or_Path n
10578 pr ", jstring j%s" n
10580 pr ", jbyteArray j%s" n
10581 | StringList n | DeviceList n ->
10582 pr ", jobjectArray j%s" n
10584 pr ", jboolean j%s" n
10592 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10593 let error_code, no_ret =
10594 match fst style with
10595 | RErr -> pr " int r;\n"; "-1", ""
10597 | RInt _ -> pr " int r;\n"; "-1", "0"
10598 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10599 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10600 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10602 pr " jstring jr;\n";
10603 pr " char *r;\n"; "NULL", "NULL"
10605 pr " jobjectArray jr;\n";
10606 pr " int r_len;\n";
10607 pr " jclass cl;\n";
10608 pr " jstring jstr;\n";
10609 pr " char **r;\n"; "NULL", "NULL"
10610 | RStruct (_, typ) ->
10611 pr " jobject jr;\n";
10612 pr " jclass cl;\n";
10613 pr " jfieldID fl;\n";
10614 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10615 | RStructList (_, typ) ->
10616 pr " jobjectArray jr;\n";
10617 pr " jclass cl;\n";
10618 pr " jfieldID fl;\n";
10619 pr " jobject jfl;\n";
10620 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10621 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10623 pr " jstring jr;\n";
10625 pr " size_t size;\n";
10630 | Device n | Dev_or_Path n
10636 pr " const char *%s;\n" n
10638 pr " jbyte *%s;\n" n;
10639 pr " size_t %s_size;\n" n
10640 | StringList n | DeviceList n ->
10641 pr " int %s_len;\n" n;
10642 pr " const char **%s;\n" n
10647 pr " int64_t %s;\n" n
10651 (match fst style with
10652 | RStringList _ | RStructList _ -> true
10653 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10654 | RConstOptString _
10655 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10656 List.exists (function
10657 | StringList _ -> true
10658 | DeviceList _ -> true
10659 | _ -> false) (snd style) in
10665 (* Get the parameters. *)
10669 | Device n | Dev_or_Path n
10674 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10676 (* This is completely undocumented, but Java null becomes
10677 * a NULL parameter.
10679 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10681 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10682 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10683 | StringList n | DeviceList n ->
10684 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10685 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10686 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10687 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10689 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10691 pr " %s[%s_len] = NULL;\n" n n;
10695 pr " %s = j%s;\n" n n
10698 (* Make the call. *)
10699 pr " r = guestfs_%s " name;
10700 generate_c_call_args ~handle:"g" style;
10703 (* Release the parameters. *)
10707 | Device n | Dev_or_Path n
10712 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10714 pr " if (j%s)\n" n;
10715 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10717 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10718 | StringList n | DeviceList n ->
10719 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10720 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10722 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10724 pr " free (%s);\n" n
10730 (* Check for errors. *)
10731 pr " if (r == %s) {\n" error_code;
10732 pr " throw_exception (env, guestfs_last_error (g));\n";
10733 pr " return %s;\n" no_ret;
10736 (* Return value. *)
10737 (match fst style with
10739 | RInt _ -> pr " return (jint) r;\n"
10740 | RBool _ -> pr " return (jboolean) r;\n"
10741 | RInt64 _ -> pr " return (jlong) r;\n"
10742 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10743 | RConstOptString _ ->
10744 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10746 pr " jr = (*env)->NewStringUTF (env, r);\n";
10750 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10751 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10752 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10753 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10754 pr " for (i = 0; i < r_len; ++i) {\n";
10755 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10756 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10757 pr " free (r[i]);\n";
10761 | RStruct (_, typ) ->
10762 let jtyp = java_name_of_struct typ in
10763 let cols = cols_of_struct typ in
10764 generate_java_struct_return typ jtyp cols
10765 | RStructList (_, typ) ->
10766 let jtyp = java_name_of_struct typ in
10767 let cols = cols_of_struct typ in
10768 generate_java_struct_list_return typ jtyp cols
10771 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10772 pr " return NULL;\n"
10774 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10783 and generate_java_struct_return typ jtyp cols =
10784 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10785 pr " jr = (*env)->AllocObject (env, cl);\n";
10789 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10790 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10793 pr " char s[33];\n";
10794 pr " memcpy (s, r->%s, 32);\n" name;
10795 pr " s[32] = 0;\n";
10796 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10797 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10801 pr " int len = r->%s_len;\n" name;
10802 pr " char s[len+1];\n";
10803 pr " memcpy (s, r->%s, len);\n" name;
10804 pr " s[len] = 0;\n";
10805 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10806 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10808 | name, (FBytes|FUInt64|FInt64) ->
10809 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10810 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10811 | name, (FUInt32|FInt32) ->
10812 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10813 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10814 | name, FOptPercent ->
10815 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10816 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10818 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10819 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10824 and generate_java_struct_list_return typ jtyp cols =
10825 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10826 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10827 pr " for (i = 0; i < r->len; ++i) {\n";
10828 pr " jfl = (*env)->AllocObject (env, cl);\n";
10832 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10833 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10836 pr " char s[33];\n";
10837 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10838 pr " s[32] = 0;\n";
10839 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10840 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10844 pr " int len = r->val[i].%s_len;\n" name;
10845 pr " char s[len+1];\n";
10846 pr " memcpy (s, r->val[i].%s, len);\n" name;
10847 pr " s[len] = 0;\n";
10848 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10849 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10851 | name, (FBytes|FUInt64|FInt64) ->
10852 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10853 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10854 | name, (FUInt32|FInt32) ->
10855 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10856 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10857 | name, FOptPercent ->
10858 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10859 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10861 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10862 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10864 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10866 pr " guestfs_free_%s_list (r);\n" typ;
10869 and generate_java_makefile_inc () =
10870 generate_header HashStyle GPLv2plus;
10872 pr "java_built_sources = \\\n";
10875 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10877 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10879 and generate_haskell_hs () =
10880 generate_header HaskellStyle LGPLv2plus;
10882 (* XXX We only know how to generate partial FFI for Haskell
10883 * at the moment. Please help out!
10885 let can_generate style =
10889 | RInt64 _, _ -> true
10891 | RConstString _, _
10892 | RConstOptString _, _
10898 | RBufferOut _, _ -> false in
10901 {-# INCLUDE <guestfs.h> #-}
10902 {-# LANGUAGE ForeignFunctionInterface #-}
10907 (* List out the names of the actions we want to export. *)
10909 fun (name, style, _, _, _, _, _) ->
10910 if can_generate style then pr ",\n %s" name
10916 -- Unfortunately some symbols duplicate ones already present
10917 -- in Prelude. We don't know which, so we hard-code a list
10919 import Prelude hiding (truncate)
10923 import Foreign.C.Types
10925 import Control.Exception
10926 import Data.Typeable
10928 data GuestfsS = GuestfsS -- represents the opaque C struct
10929 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10930 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10932 -- XXX define properly later XXX
10936 data IntBool = IntBool
10938 data StatVFS = StatVFS
10939 data Hashtable = Hashtable
10941 foreign import ccall unsafe \"guestfs_create\" c_create
10943 foreign import ccall unsafe \"&guestfs_close\" c_close
10944 :: FunPtr (GuestfsP -> IO ())
10945 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10946 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10948 create :: IO GuestfsH
10951 c_set_error_handler p nullPtr nullPtr
10952 h <- newForeignPtr c_close p
10955 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10956 :: GuestfsP -> IO CString
10958 -- last_error :: GuestfsH -> IO (Maybe String)
10959 -- last_error h = do
10960 -- str <- withForeignPtr h (\\p -> c_last_error p)
10961 -- maybePeek peekCString str
10963 last_error :: GuestfsH -> IO (String)
10965 str <- withForeignPtr h (\\p -> c_last_error p)
10966 if (str == nullPtr)
10967 then return \"no error\"
10968 else peekCString str
10972 (* Generate wrappers for each foreign function. *)
10974 fun (name, style, _, _, _, _, _) ->
10975 if can_generate style then (
10976 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10978 generate_haskell_prototype ~handle:"GuestfsP" style;
10982 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10984 pr "%s %s = do\n" name
10985 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10987 (* Convert pointer arguments using with* functions. *)
10992 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
10993 pr "withCString %s $ \\%s -> " n n
10995 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10996 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10997 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10998 | Bool _ | Int _ | Int64 _ -> ()
11000 (* Convert integer arguments. *)
11004 | Bool n -> sprintf "(fromBool %s)" n
11005 | Int n -> sprintf "(fromIntegral %s)" n
11006 | Int64 n -> sprintf "(fromIntegral %s)" n
11007 | FileIn n | FileOut n
11008 | Pathname n | Device n | Dev_or_Path n
11009 | String n | OptString n
11010 | StringList n | DeviceList n
11012 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
11014 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
11015 (String.concat " " ("p" :: args));
11016 (match fst style with
11017 | RErr | RInt _ | RInt64 _ | RBool _ ->
11018 pr " if (r == -1)\n";
11020 pr " err <- last_error h\n";
11022 | RConstString _ | RConstOptString _ | RString _
11023 | RStringList _ | RStruct _
11024 | RStructList _ | RHashtable _ | RBufferOut _ ->
11025 pr " if (r == nullPtr)\n";
11027 pr " err <- last_error h\n";
11030 (match fst style with
11032 pr " else return ()\n"
11034 pr " else return (fromIntegral r)\n"
11036 pr " else return (fromIntegral r)\n"
11038 pr " else return (toBool r)\n"
11040 | RConstOptString _
11047 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
11053 and generate_haskell_prototype ~handle ?(hs = false) style =
11054 pr "%s -> " handle;
11055 let string = if hs then "String" else "CString" in
11056 let int = if hs then "Int" else "CInt" in
11057 let bool = if hs then "Bool" else "CInt" in
11058 let int64 = if hs then "Integer" else "Int64" in
11062 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _ ->
11065 if hs then pr "String"
11066 else pr "CString -> CInt"
11067 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
11068 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
11069 | Bool _ -> pr "%s" bool
11070 | Int _ -> pr "%s" int
11071 | Int64 _ -> pr "%s" int
11072 | FileIn _ -> pr "%s" string
11073 | FileOut _ -> pr "%s" string
11078 (match fst style with
11079 | RErr -> if not hs then pr "CInt"
11080 | RInt _ -> pr "%s" int
11081 | RInt64 _ -> pr "%s" int64
11082 | RBool _ -> pr "%s" bool
11083 | RConstString _ -> pr "%s" string
11084 | RConstOptString _ -> pr "Maybe %s" string
11085 | RString _ -> pr "%s" string
11086 | RStringList _ -> pr "[%s]" string
11087 | RStruct (_, typ) ->
11088 let name = java_name_of_struct typ in
11090 | RStructList (_, typ) ->
11091 let name = java_name_of_struct typ in
11093 | RHashtable _ -> pr "Hashtable"
11094 | RBufferOut _ -> pr "%s" string
11098 and generate_csharp () =
11099 generate_header CPlusPlusStyle LGPLv2plus;
11101 (* XXX Make this configurable by the C# assembly users. *)
11102 let library = "libguestfs.so.0" in
11105 // These C# bindings are highly experimental at present.
11107 // Firstly they only work on Linux (ie. Mono). In order to get them
11108 // to work on Windows (ie. .Net) you would need to port the library
11109 // itself to Windows first.
11111 // The second issue is that some calls are known to be incorrect and
11112 // can cause Mono to segfault. Particularly: calls which pass or
11113 // return string[], or return any structure value. This is because
11114 // we haven't worked out the correct way to do this from C#.
11116 // The third issue is that when compiling you get a lot of warnings.
11117 // We are not sure whether the warnings are important or not.
11119 // Fourthly we do not routinely build or test these bindings as part
11120 // of the make && make check cycle, which means that regressions might
11123 // Suggestions and patches are welcome.
11127 // gmcs Libguestfs.cs
11128 // mono Libguestfs.exe
11130 // (You'll probably want to add a Test class / static main function
11131 // otherwise this won't do anything useful).
11135 using System.Runtime.InteropServices;
11136 using System.Runtime.Serialization;
11137 using System.Collections;
11141 class Error : System.ApplicationException
11143 public Error (string message) : base (message) {}
11144 protected Error (SerializationInfo info, StreamingContext context) {}
11151 [DllImport (\"%s\")]
11152 static extern IntPtr guestfs_create ();
11156 _handle = guestfs_create ();
11157 if (_handle == IntPtr.Zero)
11158 throw new Error (\"could not create guestfs handle\");
11161 [DllImport (\"%s\")]
11162 static extern void guestfs_close (IntPtr h);
11166 guestfs_close (_handle);
11169 [DllImport (\"%s\")]
11170 static extern string guestfs_last_error (IntPtr h);
11172 " library library library;
11174 (* Generate C# structure bindings. We prefix struct names with
11175 * underscore because C# cannot have conflicting struct names and
11176 * method names (eg. "class stat" and "stat").
11180 pr " [StructLayout (LayoutKind.Sequential)]\n";
11181 pr " public class _%s {\n" typ;
11184 | name, FChar -> pr " char %s;\n" name
11185 | name, FString -> pr " string %s;\n" name
11187 pr " uint %s_len;\n" name;
11188 pr " string %s;\n" name
11190 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
11191 pr " string %s;\n" name
11192 | name, FUInt32 -> pr " uint %s;\n" name
11193 | name, FInt32 -> pr " int %s;\n" name
11194 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
11195 | name, FInt64 -> pr " long %s;\n" name
11196 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
11202 (* Generate C# function bindings. *)
11204 fun (name, style, _, _, _, shortdesc, _) ->
11205 let rec csharp_return_type () =
11206 match fst style with
11208 | RBool n -> "bool"
11210 | RInt64 n -> "long"
11212 | RConstOptString n
11214 | RBufferOut n -> "string"
11215 | RStruct (_,n) -> "_" ^ n
11216 | RHashtable n -> "Hashtable"
11217 | RStringList n -> "string[]"
11218 | RStructList (_,n) -> sprintf "_%s[]" n
11220 and c_return_type () =
11221 match fst style with
11225 | RInt64 _ -> "long"
11227 | RConstOptString _
11229 | RBufferOut _ -> "string"
11230 | RStruct (_,n) -> "_" ^ n
11232 | RStringList _ -> "string[]"
11233 | RStructList (_,n) -> sprintf "_%s[]" n
11235 and c_error_comparison () =
11236 match fst style with
11240 | RInt64 _ -> "== -1"
11242 | RConstOptString _
11248 | RStructList (_,_) -> "== null"
11250 and generate_extern_prototype () =
11251 pr " static extern %s guestfs_%s (IntPtr h"
11252 (c_return_type ()) name;
11255 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11256 | FileIn n | FileOut n
11259 pr ", [In] string %s" n
11260 | StringList n | DeviceList n ->
11261 pr ", [In] string[] %s" n
11271 and generate_public_prototype () =
11272 pr " public %s %s (" (csharp_return_type ()) name;
11273 let comma = ref false in
11275 if !comma then pr ", ";
11280 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11281 | FileIn n | FileOut n
11284 next (); pr "string %s" n
11285 | StringList n | DeviceList n ->
11286 next (); pr "string[] %s" n
11288 next (); pr "bool %s" n
11290 next (); pr "int %s" n
11292 next (); pr "long %s" n
11296 and generate_call () =
11297 pr "guestfs_%s (_handle" name;
11298 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
11302 pr " [DllImport (\"%s\")]\n" library;
11303 generate_extern_prototype ();
11305 pr " /// <summary>\n";
11306 pr " /// %s\n" shortdesc;
11307 pr " /// </summary>\n";
11308 generate_public_prototype ();
11310 pr " %s r;\n" (c_return_type ());
11313 pr " if (r %s)\n" (c_error_comparison ());
11314 pr " throw new Error (guestfs_last_error (_handle));\n";
11315 (match fst style with
11318 pr " return r != 0 ? true : false;\n"
11320 pr " Hashtable rr = new Hashtable ();\n";
11321 pr " for (size_t i = 0; i < r.Length; i += 2)\n";
11322 pr " rr.Add (r[i], r[i+1]);\n";
11324 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
11325 | RString _ | RBufferOut _ | RStruct _ | RStringList _
11331 ) all_functions_sorted;
11337 and generate_bindtests () =
11338 generate_header CStyle LGPLv2plus;
11342 #include <stdlib.h>
11343 #include <inttypes.h>
11344 #include <string.h>
11346 #include \"guestfs.h\"
11347 #include \"guestfs-internal.h\"
11348 #include \"guestfs-internal-actions.h\"
11349 #include \"guestfs_protocol.h\"
11351 #define error guestfs_error
11352 #define safe_calloc guestfs_safe_calloc
11353 #define safe_malloc guestfs_safe_malloc
11356 print_strings (char *const *argv)
11361 for (argc = 0; argv[argc] != NULL; ++argc) {
11362 if (argc > 0) printf (\", \");
11363 printf (\"\\\"%%s\\\"\", argv[argc]);
11368 /* The test0 function prints its parameters to stdout. */
11372 match test_functions with
11373 | [] -> assert false
11374 | test0 :: tests -> test0, tests in
11377 let (name, style, _, _, _, _, _) = test0 in
11378 generate_prototype ~extern:false ~semicolon:false ~newline:true
11379 ~handle:"g" ~prefix:"guestfs__" name style;
11384 | Device n | Dev_or_Path n
11388 | Key n -> pr " printf (\"%%s\\n\", %s);\n" n
11392 pr " for (i = 0; i < %s_size; ++i)\n" n;
11393 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11394 pr " printf (\"\\n\");\n";
11396 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11397 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11398 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11399 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11400 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11402 pr " /* Java changes stdout line buffering so we need this: */\n";
11403 pr " fflush (stdout);\n";
11409 fun (name, style, _, _, _, _, _) ->
11410 if String.sub name (String.length name - 3) 3 <> "err" then (
11411 pr "/* Test normal return. */\n";
11412 generate_prototype ~extern:false ~semicolon:false ~newline:true
11413 ~handle:"g" ~prefix:"guestfs__" name style;
11415 (match fst style with
11420 pr " sscanf (val, \"%%d\", &r);\n";
11423 pr " int64_t r;\n";
11424 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11427 pr " return STREQ (val, \"true\");\n"
11429 | RConstOptString _ ->
11430 (* Can't return the input string here. Return a static
11431 * string so we ensure we get a segfault if the caller
11432 * tries to free it.
11434 pr " return \"static string\";\n"
11436 pr " return strdup (val);\n"
11438 pr " char **strs;\n";
11440 pr " sscanf (val, \"%%d\", &n);\n";
11441 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11442 pr " for (i = 0; i < n; ++i) {\n";
11443 pr " strs[i] = safe_malloc (g, 16);\n";
11444 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11446 pr " strs[n] = NULL;\n";
11447 pr " return strs;\n"
11448 | RStruct (_, typ) ->
11449 pr " struct guestfs_%s *r;\n" typ;
11450 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11452 | RStructList (_, typ) ->
11453 pr " struct guestfs_%s_list *r;\n" typ;
11454 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11455 pr " sscanf (val, \"%%d\", &r->len);\n";
11456 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11459 pr " char **strs;\n";
11461 pr " sscanf (val, \"%%d\", &n);\n";
11462 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11463 pr " for (i = 0; i < n; ++i) {\n";
11464 pr " strs[i*2] = safe_malloc (g, 16);\n";
11465 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11466 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11467 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11469 pr " strs[n*2] = NULL;\n";
11470 pr " return strs;\n"
11472 pr " return strdup (val);\n"
11477 pr "/* Test error return. */\n";
11478 generate_prototype ~extern:false ~semicolon:false ~newline:true
11479 ~handle:"g" ~prefix:"guestfs__" name style;
11481 pr " error (g, \"error\");\n";
11482 (match fst style with
11483 | RErr | RInt _ | RInt64 _ | RBool _ ->
11485 | RConstString _ | RConstOptString _
11486 | RString _ | RStringList _ | RStruct _
11490 pr " return NULL;\n"
11497 and generate_ocaml_bindtests () =
11498 generate_header OCamlStyle GPLv2plus;
11502 let g = Guestfs.create () in
11506 String.concat " " (
11509 | CallString s -> "\"" ^ s ^ "\""
11510 | CallOptString None -> "None"
11511 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11512 | CallStringList xs ->
11513 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11514 | CallInt i when i >= 0 -> string_of_int i
11515 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11516 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11517 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11518 | CallBool b -> string_of_bool b
11519 | CallBuffer s -> sprintf "%S" s
11524 generate_lang_bindtests (
11525 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11528 pr "print_endline \"EOF\"\n"
11530 and generate_perl_bindtests () =
11531 pr "#!/usr/bin/perl -w\n";
11532 generate_header HashStyle GPLv2plus;
11539 my $g = Sys::Guestfs->new ();
11543 String.concat ", " (
11546 | CallString s -> "\"" ^ s ^ "\""
11547 | CallOptString None -> "undef"
11548 | CallOptString (Some s) -> sprintf "\"%s\"" s
11549 | CallStringList xs ->
11550 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11551 | CallInt i -> string_of_int i
11552 | CallInt64 i -> Int64.to_string i
11553 | CallBool b -> if b then "1" else "0"
11554 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11559 generate_lang_bindtests (
11560 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11563 pr "print \"EOF\\n\"\n"
11565 and generate_python_bindtests () =
11566 generate_header HashStyle GPLv2plus;
11571 g = guestfs.GuestFS ()
11575 String.concat ", " (
11578 | CallString s -> "\"" ^ s ^ "\""
11579 | CallOptString None -> "None"
11580 | CallOptString (Some s) -> sprintf "\"%s\"" s
11581 | CallStringList xs ->
11582 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11583 | CallInt i -> string_of_int i
11584 | CallInt64 i -> Int64.to_string i
11585 | CallBool b -> if b then "1" else "0"
11586 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11591 generate_lang_bindtests (
11592 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11595 pr "print \"EOF\"\n"
11597 and generate_ruby_bindtests () =
11598 generate_header HashStyle GPLv2plus;
11603 g = Guestfs::create()
11607 String.concat ", " (
11610 | CallString s -> "\"" ^ s ^ "\""
11611 | CallOptString None -> "nil"
11612 | CallOptString (Some s) -> sprintf "\"%s\"" s
11613 | CallStringList xs ->
11614 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11615 | CallInt i -> string_of_int i
11616 | CallInt64 i -> Int64.to_string i
11617 | CallBool b -> string_of_bool b
11618 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11623 generate_lang_bindtests (
11624 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11627 pr "print \"EOF\\n\"\n"
11629 and generate_java_bindtests () =
11630 generate_header CStyle GPLv2plus;
11633 import com.redhat.et.libguestfs.*;
11635 public class Bindtests {
11636 public static void main (String[] argv)
11639 GuestFS g = new GuestFS ();
11643 String.concat ", " (
11646 | CallString s -> "\"" ^ s ^ "\""
11647 | CallOptString None -> "null"
11648 | CallOptString (Some s) -> sprintf "\"%s\"" s
11649 | CallStringList xs ->
11651 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11652 | CallInt i -> string_of_int i
11653 | CallInt64 i -> Int64.to_string i
11654 | CallBool b -> string_of_bool b
11656 "new byte[] { " ^ String.concat "," (
11657 map_chars (fun c -> string_of_int (Char.code c)) s
11663 generate_lang_bindtests (
11664 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11668 System.out.println (\"EOF\");
11670 catch (Exception exn) {
11671 System.err.println (exn);
11678 and generate_haskell_bindtests () =
11679 generate_header HaskellStyle GPLv2plus;
11682 module Bindtests where
11683 import qualified Guestfs
11686 g <- Guestfs.create
11690 String.concat " " (
11693 | CallString s -> "\"" ^ s ^ "\""
11694 | CallOptString None -> "Nothing"
11695 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11696 | CallStringList xs ->
11697 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11698 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11699 | CallInt i -> string_of_int i
11700 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11701 | CallInt64 i -> Int64.to_string i
11702 | CallBool true -> "True"
11703 | CallBool false -> "False"
11704 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11709 generate_lang_bindtests (
11710 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11713 pr " putStrLn \"EOF\"\n"
11715 (* Language-independent bindings tests - we do it this way to
11716 * ensure there is parity in testing bindings across all languages.
11718 and generate_lang_bindtests call =
11719 call "test0" [CallString "abc"; CallOptString (Some "def");
11720 CallStringList []; CallBool false;
11721 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11722 CallBuffer "abc\000abc"];
11723 call "test0" [CallString "abc"; CallOptString None;
11724 CallStringList []; CallBool false;
11725 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11726 CallBuffer "abc\000abc"];
11727 call "test0" [CallString ""; CallOptString (Some "def");
11728 CallStringList []; CallBool false;
11729 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11730 CallBuffer "abc\000abc"];
11731 call "test0" [CallString ""; CallOptString (Some "");
11732 CallStringList []; CallBool false;
11733 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11734 CallBuffer "abc\000abc"];
11735 call "test0" [CallString "abc"; CallOptString (Some "def");
11736 CallStringList ["1"]; CallBool false;
11737 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11738 CallBuffer "abc\000abc"];
11739 call "test0" [CallString "abc"; CallOptString (Some "def");
11740 CallStringList ["1"; "2"]; CallBool false;
11741 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11742 CallBuffer "abc\000abc"];
11743 call "test0" [CallString "abc"; CallOptString (Some "def");
11744 CallStringList ["1"]; CallBool true;
11745 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11746 CallBuffer "abc\000abc"];
11747 call "test0" [CallString "abc"; CallOptString (Some "def");
11748 CallStringList ["1"]; CallBool false;
11749 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11750 CallBuffer "abc\000abc"];
11751 call "test0" [CallString "abc"; CallOptString (Some "def");
11752 CallStringList ["1"]; CallBool false;
11753 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11754 CallBuffer "abc\000abc"];
11755 call "test0" [CallString "abc"; CallOptString (Some "def");
11756 CallStringList ["1"]; CallBool false;
11757 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11758 CallBuffer "abc\000abc"];
11759 call "test0" [CallString "abc"; CallOptString (Some "def");
11760 CallStringList ["1"]; CallBool false;
11761 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11762 CallBuffer "abc\000abc"];
11763 call "test0" [CallString "abc"; CallOptString (Some "def");
11764 CallStringList ["1"]; CallBool false;
11765 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11766 CallBuffer "abc\000abc"];
11767 call "test0" [CallString "abc"; CallOptString (Some "def");
11768 CallStringList ["1"]; CallBool false;
11769 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11770 CallBuffer "abc\000abc"]
11772 (* XXX Add here tests of the return and error functions. *)
11774 (* Code to generator bindings for virt-inspector. Currently only
11775 * implemented for OCaml code (for virt-p2v 2.0).
11777 let rng_input = "inspector/virt-inspector.rng"
11779 (* Read the input file and parse it into internal structures. This is
11780 * by no means a complete RELAX NG parser, but is just enough to be
11781 * able to parse the specific input file.
11784 | Element of string * rng list (* <element name=name/> *)
11785 | Attribute of string * rng list (* <attribute name=name/> *)
11786 | Interleave of rng list (* <interleave/> *)
11787 | ZeroOrMore of rng (* <zeroOrMore/> *)
11788 | OneOrMore of rng (* <oneOrMore/> *)
11789 | Optional of rng (* <optional/> *)
11790 | Choice of string list (* <choice><value/>*</choice> *)
11791 | Value of string (* <value>str</value> *)
11792 | Text (* <text/> *)
11794 let rec string_of_rng = function
11795 | Element (name, xs) ->
11796 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11797 | Attribute (name, xs) ->
11798 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11799 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11800 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11801 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11802 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11803 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11804 | Value value -> "Value \"" ^ value ^ "\""
11807 and string_of_rng_list xs =
11808 String.concat ", " (List.map string_of_rng xs)
11810 let rec parse_rng ?defines context = function
11812 | Xml.Element ("element", ["name", name], children) :: rest ->
11813 Element (name, parse_rng ?defines context children)
11814 :: parse_rng ?defines context rest
11815 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11816 Attribute (name, parse_rng ?defines context children)
11817 :: parse_rng ?defines context rest
11818 | Xml.Element ("interleave", [], children) :: rest ->
11819 Interleave (parse_rng ?defines context children)
11820 :: parse_rng ?defines context rest
11821 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11822 let rng = parse_rng ?defines context [child] in
11824 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11826 failwithf "%s: <zeroOrMore> contains more than one child element"
11829 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11830 let rng = parse_rng ?defines context [child] in
11832 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11834 failwithf "%s: <oneOrMore> contains more than one child element"
11837 | Xml.Element ("optional", [], [child]) :: rest ->
11838 let rng = parse_rng ?defines context [child] in
11840 | [child] -> Optional child :: parse_rng ?defines context rest
11842 failwithf "%s: <optional> contains more than one child element"
11845 | Xml.Element ("choice", [], children) :: rest ->
11846 let values = List.map (
11847 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11849 failwithf "%s: can't handle anything except <value> in <choice>"
11853 :: parse_rng ?defines context rest
11854 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11855 Value value :: parse_rng ?defines context rest
11856 | Xml.Element ("text", [], []) :: rest ->
11857 Text :: parse_rng ?defines context rest
11858 | Xml.Element ("ref", ["name", name], []) :: rest ->
11859 (* Look up the reference. Because of limitations in this parser,
11860 * we can't handle arbitrarily nested <ref> yet. You can only
11861 * use <ref> from inside <start>.
11863 (match defines with
11865 failwithf "%s: contains <ref>, but no refs are defined yet" context
11867 let rng = StringMap.find name map in
11868 rng @ parse_rng ?defines context rest
11871 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11874 let xml = Xml.parse_file rng_input in
11876 | Xml.Element ("grammar", _,
11877 Xml.Element ("start", _, gram) :: defines) ->
11878 (* The <define/> elements are referenced in the <start> section,
11879 * so build a map of those first.
11881 let defines = List.fold_left (
11883 function Xml.Element ("define", ["name", name], defn) ->
11884 StringMap.add name defn map
11886 failwithf "%s: expected <define name=name/>" rng_input
11887 ) StringMap.empty defines in
11888 let defines = StringMap.mapi parse_rng defines in
11890 (* Parse the <start> clause, passing the defines. *)
11891 parse_rng ~defines "<start>" gram
11893 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11896 let name_of_field = function
11897 | Element (name, _) | Attribute (name, _)
11898 | ZeroOrMore (Element (name, _))
11899 | OneOrMore (Element (name, _))
11900 | Optional (Element (name, _)) -> name
11901 | Optional (Attribute (name, _)) -> name
11902 | Text -> (* an unnamed field in an element *)
11905 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11907 (* At the moment this function only generates OCaml types. However we
11908 * should parameterize it later so it can generate types/structs in a
11909 * variety of languages.
11911 let generate_types xs =
11912 (* A simple type is one that can be printed out directly, eg.
11913 * "string option". A complex type is one which has a name and has
11914 * to be defined via another toplevel definition, eg. a struct.
11916 * generate_type generates code for either simple or complex types.
11917 * In the simple case, it returns the string ("string option"). In
11918 * the complex case, it returns the name ("mountpoint"). In the
11919 * complex case it has to print out the definition before returning,
11920 * so it should only be called when we are at the beginning of a
11921 * new line (BOL context).
11923 let rec generate_type = function
11924 | Text -> (* string *)
11926 | Choice values -> (* [`val1|`val2|...] *)
11927 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11928 | ZeroOrMore rng -> (* <rng> list *)
11929 let t, is_simple = generate_type rng in
11930 t ^ " list (* 0 or more *)", is_simple
11931 | OneOrMore rng -> (* <rng> list *)
11932 let t, is_simple = generate_type rng in
11933 t ^ " list (* 1 or more *)", is_simple
11934 (* virt-inspector hack: bool *)
11935 | Optional (Attribute (name, [Value "1"])) ->
11937 | Optional rng -> (* <rng> list *)
11938 let t, is_simple = generate_type rng in
11939 t ^ " option", is_simple
11940 (* type name = { fields ... } *)
11941 | Element (name, fields) when is_attrs_interleave fields ->
11942 generate_type_struct name (get_attrs_interleave fields)
11943 | Element (name, [field]) (* type name = field *)
11944 | Attribute (name, [field]) ->
11945 let t, is_simple = generate_type field in
11946 if is_simple then (t, true)
11948 pr "type %s = %s\n" name t;
11951 | Element (name, fields) -> (* type name = { fields ... } *)
11952 generate_type_struct name fields
11954 failwithf "generate_type failed at: %s" (string_of_rng rng)
11956 and is_attrs_interleave = function
11957 | [Interleave _] -> true
11958 | Attribute _ :: fields -> is_attrs_interleave fields
11959 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11962 and get_attrs_interleave = function
11963 | [Interleave fields] -> fields
11964 | ((Attribute _) as field) :: fields
11965 | ((Optional (Attribute _)) as field) :: fields ->
11966 field :: get_attrs_interleave fields
11967 | _ -> assert false
11969 and generate_types xs =
11970 List.iter (fun x -> ignore (generate_type x)) xs
11972 and generate_type_struct name fields =
11973 (* Calculate the types of the fields first. We have to do this
11974 * before printing anything so we are still in BOL context.
11976 let types = List.map fst (List.map generate_type fields) in
11978 (* Special case of a struct containing just a string and another
11979 * field. Turn it into an assoc list.
11982 | ["string"; other] ->
11983 let fname1, fname2 =
11985 | [f1; f2] -> name_of_field f1, name_of_field f2
11986 | _ -> assert false in
11987 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11991 pr "type %s = {\n" name;
11993 fun (field, ftype) ->
11994 let fname = name_of_field field in
11995 pr " %s_%s : %s;\n" name fname ftype
11996 ) (List.combine fields types);
11998 (* Return the name of this type, and
11999 * false because it's not a simple type.
12006 let generate_parsers xs =
12007 (* As for generate_type above, generate_parser makes a parser for
12008 * some type, and returns the name of the parser it has generated.
12009 * Because it (may) need to print something, it should always be
12010 * called in BOL context.
12012 let rec generate_parser = function
12013 | Text -> (* string *)
12014 "string_child_or_empty"
12015 | Choice values -> (* [`val1|`val2|...] *)
12016 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
12018 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
12019 | ZeroOrMore rng -> (* <rng> list *)
12020 let pa = generate_parser rng in
12021 sprintf "(fun x -> List.map %s (Xml.children x))" pa
12022 | OneOrMore rng -> (* <rng> list *)
12023 let pa = generate_parser rng in
12024 sprintf "(fun x -> List.map %s (Xml.children x))" pa
12025 (* virt-inspector hack: bool *)
12026 | Optional (Attribute (name, [Value "1"])) ->
12027 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
12028 | Optional rng -> (* <rng> list *)
12029 let pa = generate_parser rng in
12030 sprintf "(function None -> None | Some x -> Some (%s x))" pa
12031 (* type name = { fields ... } *)
12032 | Element (name, fields) when is_attrs_interleave fields ->
12033 generate_parser_struct name (get_attrs_interleave fields)
12034 | Element (name, [field]) -> (* type name = field *)
12035 let pa = generate_parser field in
12036 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
12037 pr "let %s =\n" parser_name;
12039 pr "let parse_%s = %s\n" name parser_name;
12041 | Attribute (name, [field]) ->
12042 let pa = generate_parser field in
12043 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
12044 pr "let %s =\n" parser_name;
12046 pr "let parse_%s = %s\n" name parser_name;
12048 | Element (name, fields) -> (* type name = { fields ... } *)
12049 generate_parser_struct name ([], fields)
12051 failwithf "generate_parser failed at: %s" (string_of_rng rng)
12053 and is_attrs_interleave = function
12054 | [Interleave _] -> true
12055 | Attribute _ :: fields -> is_attrs_interleave fields
12056 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
12059 and get_attrs_interleave = function
12060 | [Interleave fields] -> [], fields
12061 | ((Attribute _) as field) :: fields
12062 | ((Optional (Attribute _)) as field) :: fields ->
12063 let attrs, interleaves = get_attrs_interleave fields in
12064 (field :: attrs), interleaves
12065 | _ -> assert false
12067 and generate_parsers xs =
12068 List.iter (fun x -> ignore (generate_parser x)) xs
12070 and generate_parser_struct name (attrs, interleaves) =
12071 (* Generate parsers for the fields first. We have to do this
12072 * before printing anything so we are still in BOL context.
12074 let fields = attrs @ interleaves in
12075 let pas = List.map generate_parser fields in
12077 (* Generate an intermediate tuple from all the fields first.
12078 * If the type is just a string + another field, then we will
12079 * return this directly, otherwise it is turned into a record.
12081 * RELAX NG note: This code treats <interleave> and plain lists of
12082 * fields the same. In other words, it doesn't bother enforcing
12083 * any ordering of fields in the XML.
12085 pr "let parse_%s x =\n" name;
12086 pr " let t = (\n ";
12087 let comma = ref false in
12090 if !comma then pr ",\n ";
12093 | Optional (Attribute (fname, [field])), pa ->
12095 | Optional (Element (fname, [field])), pa ->
12096 pr "%s (optional_child %S x)" pa fname
12097 | Attribute (fname, [Text]), _ ->
12098 pr "attribute %S x" fname
12099 | (ZeroOrMore _ | OneOrMore _), pa ->
12104 let fname = name_of_field field in
12105 pr "%s (child %S x)" pa fname
12106 ) (List.combine fields pas);
12110 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
12114 pr " (Obj.magic t : %s)\n" name
12118 | (Optional (Attribute (fname, [field])), pa) ->
12119 pr " %s_%s =\n" name fname;
12121 | (Optional (Element (fname, [field])), pa) ->
12122 pr " %s_%s =\n" name fname;
12123 pr " (let x = optional_child %S x in\n" fname;
12126 let fname = name_of_field field in
12127 pr " %s_%s =\n" name fname;
12128 pr " (let x = child %S x in\n" fname;
12130 ) (List.combine fields pas);
12134 sprintf "parse_%s" name
12137 generate_parsers xs
12139 (* Generate ocaml/guestfs_inspector.mli. *)
12140 let generate_ocaml_inspector_mli () =
12141 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
12144 (** This is an OCaml language binding to the external [virt-inspector]
12147 For more information, please read the man page [virt-inspector(1)].
12152 generate_types grammar;
12153 pr "(** The nested information returned from the {!inspect} function. *)\n";
12157 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
12158 (** To inspect a libvirt domain called [name], pass a singleton
12159 list: [inspect [name]]. When using libvirt only, you may
12160 optionally pass a libvirt URI using [inspect ~connect:uri ...].
12162 To inspect a disk image or images, pass a list of the filenames
12163 of the disk images: [inspect filenames]
12165 This function inspects the given guest or disk images and
12166 returns a list of operating system(s) found and a large amount
12167 of information about them. In the vast majority of cases,
12168 a virtual machine only contains a single operating system.
12170 If the optional [~xml] parameter is given, then this function
12171 skips running the external virt-inspector program and just
12172 parses the given XML directly (which is expected to be XML
12173 produced from a previous run of virt-inspector). The list of
12174 names and connect URI are ignored in this case.
12176 This function can throw a wide variety of exceptions, for example
12177 if the external virt-inspector program cannot be found, or if
12178 it doesn't generate valid XML.
12182 (* Generate ocaml/guestfs_inspector.ml. *)
12183 let generate_ocaml_inspector_ml () =
12184 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
12189 generate_types grammar;
12193 (* Misc functions which are used by the parser code below. *)
12194 let first_child = function
12195 | Xml.Element (_, _, c::_) -> c
12196 | Xml.Element (name, _, []) ->
12197 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
12198 | Xml.PCData str ->
12199 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
12201 let string_child_or_empty = function
12202 | Xml.Element (_, _, [Xml.PCData s]) -> s
12203 | Xml.Element (_, _, []) -> \"\"
12204 | Xml.Element (x, _, _) ->
12205 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
12207 | Xml.PCData str ->
12208 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
12210 let optional_child name xml =
12211 let children = Xml.children xml in
12213 Some (List.find (function
12214 | Xml.Element (n, _, _) when n = name -> true
12215 | _ -> false) children)
12219 let child name xml =
12220 match optional_child name xml with
12223 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
12225 let attribute name xml =
12226 try Xml.attrib xml name
12227 with Xml.No_attribute _ ->
12228 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
12232 generate_parsers grammar;
12236 (* Run external virt-inspector, then use parser to parse the XML. *)
12237 let inspect ?connect ?xml names =
12241 if names = [] then invalid_arg \"inspect: no names given\";
12242 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
12243 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
12245 let cmd = List.map Filename.quote cmd in
12246 let cmd = String.concat \" \" cmd in
12247 let chan = open_process_in cmd in
12248 let xml = Xml.parse_in chan in
12249 (match close_process_in chan with
12251 | WEXITED _ -> failwith \"external virt-inspector command failed\"
12252 | WSIGNALED i | WSTOPPED i ->
12253 failwith (\"external virt-inspector command died or stopped on sig \" ^
12258 Xml.parse_string doc in
12259 parse_operatingsystems xml
12262 and generate_max_proc_nr () =
12263 pr "%d\n" max_proc_nr
12265 let output_to filename k =
12266 let filename_new = filename ^ ".new" in
12267 chan := open_out filename_new;
12270 chan := Pervasives.stdout;
12272 (* Is the new file different from the current file? *)
12273 if Sys.file_exists filename && files_equal filename filename_new then
12274 unlink filename_new (* same, so skip it *)
12276 (* different, overwrite old one *)
12277 (try chmod filename 0o644 with Unix_error _ -> ());
12278 rename filename_new filename;
12279 chmod filename 0o444;
12280 printf "written %s\n%!" filename;
12283 let perror msg = function
12284 | Unix_error (err, _, _) ->
12285 eprintf "%s: %s\n" msg (error_message err)
12287 eprintf "%s: %s\n" msg (Printexc.to_string exn)
12289 (* Main program. *)
12292 try openfile "HACKING" [O_RDWR] 0
12294 | Unix_error (ENOENT, _, _) ->
12296 You are probably running this from the wrong directory.
12297 Run it from the top source directory using the command
12302 perror "open: HACKING" exn;
12305 (* Acquire a lock so parallel builds won't try to run the generator
12306 * twice at the same time. Subsequent builds will wait for the first
12307 * one to finish. Note the lock is released implicitly when the
12310 (try lockf lock_fd F_LOCK 1
12312 perror "lock: HACKING" exn;
12315 check_functions ();
12317 output_to "src/guestfs_protocol.x" generate_xdr;
12318 output_to "src/guestfs-structs.h" generate_structs_h;
12319 output_to "src/guestfs-actions.h" generate_actions_h;
12320 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
12321 output_to "src/guestfs-actions.c" generate_client_actions;
12322 output_to "src/guestfs-bindtests.c" generate_bindtests;
12323 output_to "src/guestfs-structs.pod" generate_structs_pod;
12324 output_to "src/guestfs-actions.pod" generate_actions_pod;
12325 output_to "src/guestfs-availability.pod" generate_availability_pod;
12326 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
12327 output_to "src/libguestfs.syms" generate_linker_script;
12328 output_to "daemon/actions.h" generate_daemon_actions_h;
12329 output_to "daemon/stubs.c" generate_daemon_actions;
12330 output_to "daemon/names.c" generate_daemon_names;
12331 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
12332 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
12333 output_to "capitests/tests.c" generate_tests;
12334 output_to "fish/cmds.c" generate_fish_cmds;
12335 output_to "fish/completion.c" generate_fish_completion;
12336 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
12337 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
12338 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
12339 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
12340 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
12341 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
12342 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
12343 output_to "perl/Guestfs.xs" generate_perl_xs;
12344 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
12345 output_to "perl/bindtests.pl" generate_perl_bindtests;
12346 output_to "python/guestfs-py.c" generate_python_c;
12347 output_to "python/guestfs.py" generate_python_py;
12348 output_to "python/bindtests.py" generate_python_bindtests;
12349 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12350 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12351 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12355 let cols = cols_of_struct typ in
12356 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12357 output_to filename (generate_java_struct jtyp cols);
12360 output_to "java/Makefile.inc" generate_java_makefile_inc;
12361 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12362 output_to "java/Bindtests.java" generate_java_bindtests;
12363 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12364 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12365 output_to "csharp/Libguestfs.cs" generate_csharp;
12367 (* Always generate this file last, and unconditionally. It's used
12368 * by the Makefile to know when we must re-run the generator.
12370 let chan = open_out "src/stamp-generator" in
12371 fprintf chan "1\n";
12374 printf "generated %d lines of code\n" !lines