3 * Copyright (C) 2009-2010 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <const char *, size_t> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
177 (* Key material / passphrase. Eventually we should treat this
178 * as sensitive and mlock it into physical RAM. However this
179 * is highly complex because of all the places that XDR-encoded
180 * strings can end up. So currently the only difference from
181 * 'String' is the way that guestfish requests these parameters
187 | ProtocolLimitWarning (* display warning about protocol size limits *)
188 | DangerWillRobinson (* flags particularly dangerous commands *)
189 | FishAlias of string (* provide an alias for this cmd in guestfish *)
190 | FishOutput of fish_output_t (* how to display output in guestfish *)
191 | NotInFish (* do not export via guestfish *)
192 | NotInDocs (* do not add this function to documentation *)
193 | DeprecatedBy of string (* function is deprecated, use .. instead *)
194 | Optional of string (* function is part of an optional group *)
197 | FishOutputOctal (* for int return, print in octal *)
198 | FishOutputHexadecimal (* for int return, print in hex *)
200 (* You can supply zero or as many tests as you want per API call.
202 * Note that the test environment has 3 block devices, of size 500MB,
203 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
204 * a fourth ISO block device with some known files on it (/dev/sdd).
206 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
207 * Number of cylinders was 63 for IDE emulated disks with precisely
208 * the same size. How exactly this is calculated is a mystery.
210 * The ISO block device (/dev/sdd) comes from images/test.iso.
212 * To be able to run the tests in a reasonable amount of time,
213 * the virtual machine and block devices are reused between tests.
214 * So don't try testing kill_subprocess :-x
216 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
218 * Don't assume anything about the previous contents of the block
219 * devices. Use 'Init*' to create some initial scenarios.
221 * You can add a prerequisite clause to any individual test. This
222 * is a run-time check, which, if it fails, causes the test to be
223 * skipped. Useful if testing a command which might not work on
224 * all variations of libguestfs builds. A test that has prerequisite
225 * of 'Always' is run unconditionally.
227 * In addition, packagers can skip individual tests by setting the
228 * environment variables: eg:
229 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
230 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
232 type tests = (test_init * test_prereq * test) list
234 (* Run the command sequence and just expect nothing to fail. *)
237 (* Run the command sequence and expect the output of the final
238 * command to be the string.
240 | TestOutput of seq * string
242 (* Run the command sequence and expect the output of the final
243 * command to be the list of strings.
245 | TestOutputList of seq * string list
247 (* Run the command sequence and expect the output of the final
248 * command to be the list of block devices (could be either
249 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
250 * character of each string).
252 | TestOutputListOfDevices of seq * string list
254 (* Run the command sequence and expect the output of the final
255 * command to be the integer.
257 | TestOutputInt of seq * int
259 (* Run the command sequence and expect the output of the final
260 * command to be <op> <int>, eg. ">=", "1".
262 | TestOutputIntOp of seq * string * int
264 (* Run the command sequence and expect the output of the final
265 * command to be a true value (!= 0 or != NULL).
267 | TestOutputTrue of seq
269 (* Run the command sequence and expect the output of the final
270 * command to be a false value (== 0 or == NULL, but not an error).
272 | TestOutputFalse of seq
274 (* Run the command sequence and expect the output of the final
275 * command to be a list of the given length (but don't care about
278 | TestOutputLength of seq * int
280 (* Run the command sequence and expect the output of the final
281 * command to be a buffer (RBufferOut), ie. string + size.
283 | TestOutputBuffer of seq * string
285 (* Run the command sequence and expect the output of the final
286 * command to be a structure.
288 | TestOutputStruct of seq * test_field_compare list
290 (* Run the command sequence and expect the final command (only)
293 | TestLastFail of seq
295 and test_field_compare =
296 | CompareWithInt of string * int
297 | CompareWithIntOp of string * string * int
298 | CompareWithString of string * string
299 | CompareFieldsIntEq of string * string
300 | CompareFieldsStrEq of string * string
302 (* Test prerequisites. *)
304 (* Test always runs. *)
307 (* Test is currently disabled - eg. it fails, or it tests some
308 * unimplemented feature.
312 (* 'string' is some C code (a function body) that should return
313 * true or false. The test will run if the code returns true.
317 (* As for 'If' but the test runs _unless_ the code returns true. *)
320 (* Run the test only if 'string' is available in the daemon. *)
321 | IfAvailable of string
323 (* Some initial scenarios for testing. *)
325 (* Do nothing, block devices could contain random stuff including
326 * LVM PVs, and some filesystems might be mounted. This is usually
331 (* Block devices are empty and no filesystems are mounted. *)
334 (* /dev/sda contains a single partition /dev/sda1, with random
335 * content. /dev/sdb and /dev/sdc may have random content.
340 (* /dev/sda contains a single partition /dev/sda1, which is formatted
341 * as ext2, empty [except for lost+found] and mounted on /.
342 * /dev/sdb and /dev/sdc may have random content.
348 * /dev/sda1 (is a PV):
349 * /dev/VG/LV (size 8MB):
350 * formatted as ext2, empty [except for lost+found], mounted on /
351 * /dev/sdb and /dev/sdc may have random content.
355 (* /dev/sdd (the ISO, see images/ directory in source)
360 (* Sequence of commands for testing. *)
362 and cmd = string list
364 (* Note about long descriptions: When referring to another
365 * action, use the format C<guestfs_other> (ie. the full name of
366 * the C function). This will be replaced as appropriate in other
369 * Apart from that, long descriptions are just perldoc paragraphs.
372 (* Generate a random UUID (used in tests). *)
374 let chan = open_process_in "uuidgen" in
375 let uuid = input_line chan in
376 (match close_process_in chan with
379 failwith "uuidgen: process exited with non-zero status"
380 | WSIGNALED _ | WSTOPPED _ ->
381 failwith "uuidgen: process signalled or stopped by signal"
385 (* These test functions are used in the language binding tests. *)
387 let test_all_args = [
390 StringList "strlist";
399 let test_all_rets = [
400 (* except for RErr, which is tested thoroughly elsewhere *)
401 "test0rint", RInt "valout";
402 "test0rint64", RInt64 "valout";
403 "test0rbool", RBool "valout";
404 "test0rconststring", RConstString "valout";
405 "test0rconstoptstring", RConstOptString "valout";
406 "test0rstring", RString "valout";
407 "test0rstringlist", RStringList "valout";
408 "test0rstruct", RStruct ("valout", "lvm_pv");
409 "test0rstructlist", RStructList ("valout", "lvm_pv");
410 "test0rhashtable", RHashtable "valout";
413 let test_functions = [
414 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
416 "internal test function - do not use",
418 This is an internal test function which is used to test whether
419 the automatically generated bindings can handle every possible
420 parameter type correctly.
422 It echos the contents of each parameter to stdout.
424 You probably don't want to call this function.");
428 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
430 "internal test function - do not use",
432 This is an internal test function which is used to test whether
433 the automatically generated bindings can handle every possible
434 return type correctly.
436 It converts string C<val> to the return type.
438 You probably don't want to call this function.");
439 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
441 "internal test function - do not use",
443 This is an internal test function which is used to test whether
444 the automatically generated bindings can handle every possible
445 return type correctly.
447 This function always returns an error.
449 You probably don't want to call this function.")]
453 (* non_daemon_functions are any functions which don't get processed
454 * in the daemon, eg. functions for setting and getting local
455 * configuration values.
458 let non_daemon_functions = test_functions @ [
459 ("launch", (RErr, []), -1, [FishAlias "run"],
461 "launch the qemu subprocess",
463 Internally libguestfs is implemented by running a virtual machine
466 You should call this after configuring the handle
467 (eg. adding drives) but before performing any actions.");
469 ("wait_ready", (RErr, []), -1, [NotInFish],
471 "wait until the qemu subprocess launches (no op)",
473 This function is a no op.
475 In versions of the API E<lt> 1.0.71 you had to call this function
476 just after calling C<guestfs_launch> to wait for the launch
477 to complete. However this is no longer necessary because
478 C<guestfs_launch> now does the waiting.
480 If you see any calls to this function in code then you can just
481 remove them, unless you want to retain compatibility with older
482 versions of the API.");
484 ("kill_subprocess", (RErr, []), -1, [],
486 "kill the qemu subprocess",
488 This kills the qemu subprocess. You should never need to call this.");
490 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
492 "add an image to examine or modify",
494 This function adds a virtual machine disk image C<filename> to the
495 guest. The first time you call this function, the disk appears as IDE
496 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
499 You don't necessarily need to be root when using libguestfs. However
500 you obviously do need sufficient permissions to access the filename
501 for whatever operations you want to perform (ie. read access if you
502 just want to read the image or write access if you want to modify the
505 This is equivalent to the qemu parameter
506 C<-drive file=filename,cache=off,if=...>.
508 C<cache=off> is omitted in cases where it is not supported by
509 the underlying filesystem.
511 C<if=...> is set at compile time by the configuration option
512 C<./configure --with-drive-if=...>. In the rare case where you
513 might need to change this at run time, use C<guestfs_add_drive_with_if>
514 or C<guestfs_add_drive_ro_with_if>.
516 Note that this call checks for the existence of C<filename>. This
517 stops you from specifying other types of drive which are supported
518 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
519 the general C<guestfs_config> call instead.");
521 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
523 "add a CD-ROM disk image to examine",
525 This function adds a virtual CD-ROM disk image to the guest.
527 This is equivalent to the qemu parameter C<-cdrom filename>.
535 This call checks for the existence of C<filename>. This
536 stops you from specifying other types of drive which are supported
537 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
538 the general C<guestfs_config> call instead.
542 If you just want to add an ISO file (often you use this as an
543 efficient way to transfer large files into the guest), then you
544 should probably use C<guestfs_add_drive_ro> instead.
548 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
550 "add a drive in snapshot mode (read-only)",
552 This adds a drive in snapshot mode, making it effectively
555 Note that writes to the device are allowed, and will be seen for
556 the duration of the guestfs handle, but they are written
557 to a temporary file which is discarded as soon as the guestfs
558 handle is closed. We don't currently have any method to enable
559 changes to be committed, although qemu can support this.
561 This is equivalent to the qemu parameter
562 C<-drive file=filename,snapshot=on,if=...>.
564 C<if=...> is set at compile time by the configuration option
565 C<./configure --with-drive-if=...>. In the rare case where you
566 might need to change this at run time, use C<guestfs_add_drive_with_if>
567 or C<guestfs_add_drive_ro_with_if>.
569 Note that this call checks for the existence of C<filename>. This
570 stops you from specifying other types of drive which are supported
571 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
572 the general C<guestfs_config> call instead.");
574 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
576 "add qemu parameters",
578 This can be used to add arbitrary qemu command line parameters
579 of the form C<-param value>. Actually it's not quite arbitrary - we
580 prevent you from setting some parameters which would interfere with
581 parameters that we use.
583 The first character of C<param> string must be a C<-> (dash).
585 C<value> can be NULL.");
587 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
589 "set the qemu binary",
591 Set the qemu binary that we will use.
593 The default is chosen when the library was compiled by the
596 You can also override this by setting the C<LIBGUESTFS_QEMU>
597 environment variable.
599 Setting C<qemu> to C<NULL> restores the default qemu binary.
601 Note that you should call this function as early as possible
602 after creating the handle. This is because some pre-launch
603 operations depend on testing qemu features (by running C<qemu -help>).
604 If the qemu binary changes, we don't retest features, and
605 so you might see inconsistent results. Using the environment
606 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
607 the qemu binary at the same time as the handle is created.");
609 ("get_qemu", (RConstString "qemu", []), -1, [],
610 [InitNone, Always, TestRun (
612 "get the qemu binary",
614 Return the current qemu binary.
616 This is always non-NULL. If it wasn't set already, then this will
617 return the default qemu binary name.");
619 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
621 "set the search path",
623 Set the path that libguestfs searches for kernel and initrd.img.
625 The default is C<$libdir/guestfs> unless overridden by setting
626 C<LIBGUESTFS_PATH> environment variable.
628 Setting C<path> to C<NULL> restores the default path.");
630 ("get_path", (RConstString "path", []), -1, [],
631 [InitNone, Always, TestRun (
633 "get the search path",
635 Return the current search path.
637 This is always non-NULL. If it wasn't set already, then this will
638 return the default path.");
640 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
642 "add options to kernel command line",
644 This function is used to add additional options to the
645 guest kernel command line.
647 The default is C<NULL> unless overridden by setting
648 C<LIBGUESTFS_APPEND> environment variable.
650 Setting C<append> to C<NULL> means I<no> additional options
651 are passed (libguestfs always adds a few of its own).");
653 ("get_append", (RConstOptString "append", []), -1, [],
654 (* This cannot be tested with the current framework. The
655 * function can return NULL in normal operations, which the
656 * test framework interprets as an error.
659 "get the additional kernel options",
661 Return the additional kernel options which are added to the
662 guest kernel command line.
664 If C<NULL> then no options are added.");
666 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
670 If C<autosync> is true, this enables autosync. Libguestfs will make a
671 best effort attempt to run C<guestfs_umount_all> followed by
672 C<guestfs_sync> when the handle is closed
673 (also if the program exits without closing handles).
675 This is disabled by default (except in guestfish where it is
676 enabled by default).");
678 ("get_autosync", (RBool "autosync", []), -1, [],
679 [InitNone, Always, TestRun (
680 [["get_autosync"]])],
683 Get the autosync flag.");
685 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
689 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
691 Verbose messages are disabled unless the environment variable
692 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
694 ("get_verbose", (RBool "verbose", []), -1, [],
698 This returns the verbose messages flag.");
700 ("is_ready", (RBool "ready", []), -1, [],
701 [InitNone, Always, TestOutputTrue (
703 "is ready to accept commands",
705 This returns true iff this handle is ready to accept commands
706 (in the C<READY> state).
708 For more information on states, see L<guestfs(3)>.");
710 ("is_config", (RBool "config", []), -1, [],
711 [InitNone, Always, TestOutputFalse (
713 "is in configuration state",
715 This returns true iff this handle is being configured
716 (in the C<CONFIG> state).
718 For more information on states, see L<guestfs(3)>.");
720 ("is_launching", (RBool "launching", []), -1, [],
721 [InitNone, Always, TestOutputFalse (
722 [["is_launching"]])],
723 "is launching subprocess",
725 This returns true iff this handle is launching the subprocess
726 (in the C<LAUNCHING> state).
728 For more information on states, see L<guestfs(3)>.");
730 ("is_busy", (RBool "busy", []), -1, [],
731 [InitNone, Always, TestOutputFalse (
733 "is busy processing a command",
735 This returns true iff this handle is busy processing a command
736 (in the C<BUSY> state).
738 For more information on states, see L<guestfs(3)>.");
740 ("get_state", (RInt "state", []), -1, [],
742 "get the current state",
744 This returns the current state as an opaque integer. This is
745 only useful for printing debug and internal error messages.
747 For more information on states, see L<guestfs(3)>.");
749 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
750 [InitNone, Always, TestOutputInt (
751 [["set_memsize"; "500"];
752 ["get_memsize"]], 500)],
753 "set memory allocated to the qemu subprocess",
755 This sets the memory size in megabytes allocated to the
756 qemu subprocess. This only has any effect if called before
759 You can also change this by setting the environment
760 variable C<LIBGUESTFS_MEMSIZE> before the handle is
763 For more information on the architecture of libguestfs,
764 see L<guestfs(3)>.");
766 ("get_memsize", (RInt "memsize", []), -1, [],
767 [InitNone, Always, TestOutputIntOp (
768 [["get_memsize"]], ">=", 256)],
769 "get memory allocated to the qemu subprocess",
771 This gets the memory size in megabytes allocated to the
774 If C<guestfs_set_memsize> was not called
775 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
776 then this returns the compiled-in default value for memsize.
778 For more information on the architecture of libguestfs,
779 see L<guestfs(3)>.");
781 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
782 [InitNone, Always, TestOutputIntOp (
783 [["get_pid"]], ">=", 1)],
784 "get PID of qemu subprocess",
786 Return the process ID of the qemu subprocess. If there is no
787 qemu subprocess, then this will return an error.
789 This is an internal call used for debugging and testing.");
791 ("version", (RStruct ("version", "version"), []), -1, [],
792 [InitNone, Always, TestOutputStruct (
793 [["version"]], [CompareWithInt ("major", 1)])],
794 "get the library version number",
796 Return the libguestfs version number that the program is linked
799 Note that because of dynamic linking this is not necessarily
800 the version of libguestfs that you compiled against. You can
801 compile the program, and then at runtime dynamically link
802 against a completely different C<libguestfs.so> library.
804 This call was added in version C<1.0.58>. In previous
805 versions of libguestfs there was no way to get the version
806 number. From C code you can use dynamic linker functions
807 to find out if this symbol exists (if it doesn't, then
808 it's an earlier version).
810 The call returns a structure with four elements. The first
811 three (C<major>, C<minor> and C<release>) are numbers and
812 correspond to the usual version triplet. The fourth element
813 (C<extra>) is a string and is normally empty, but may be
814 used for distro-specific information.
816 To construct the original version string:
817 C<$major.$minor.$release$extra>
819 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
821 I<Note:> Don't use this call to test for availability
822 of features. In enterprise distributions we backport
823 features from later versions into earlier versions,
824 making this an unreliable way to test for features.
825 Use C<guestfs_available> instead.");
827 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
828 [InitNone, Always, TestOutputTrue (
829 [["set_selinux"; "true"];
831 "set SELinux enabled or disabled at appliance boot",
833 This sets the selinux flag that is passed to the appliance
834 at boot time. The default is C<selinux=0> (disabled).
836 Note that if SELinux is enabled, it is always in
837 Permissive mode (C<enforcing=0>).
839 For more information on the architecture of libguestfs,
840 see L<guestfs(3)>.");
842 ("get_selinux", (RBool "selinux", []), -1, [],
844 "get SELinux enabled flag",
846 This returns the current setting of the selinux flag which
847 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
849 For more information on the architecture of libguestfs,
850 see L<guestfs(3)>.");
852 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
853 [InitNone, Always, TestOutputFalse (
854 [["set_trace"; "false"];
856 "enable or disable command traces",
858 If the command trace flag is set to 1, then commands are
859 printed on stderr before they are executed in a format
860 which is very similar to the one used by guestfish. In
861 other words, you can run a program with this enabled, and
862 you will get out a script which you can feed to guestfish
863 to perform the same set of actions.
865 If you want to trace C API calls into libguestfs (and
866 other libraries) then possibly a better way is to use
867 the external ltrace(1) command.
869 Command traces are disabled unless the environment variable
870 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
872 ("get_trace", (RBool "trace", []), -1, [],
874 "get command trace enabled flag",
876 Return the command trace flag.");
878 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
879 [InitNone, Always, TestOutputFalse (
880 [["set_direct"; "false"];
882 "enable or disable direct appliance mode",
884 If the direct appliance mode flag is enabled, then stdin and
885 stdout are passed directly through to the appliance once it
888 One consequence of this is that log messages aren't caught
889 by the library and handled by C<guestfs_set_log_message_callback>,
890 but go straight to stdout.
892 You probably don't want to use this unless you know what you
895 The default is disabled.");
897 ("get_direct", (RBool "direct", []), -1, [],
899 "get direct appliance mode flag",
901 Return the direct appliance mode flag.");
903 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
904 [InitNone, Always, TestOutputTrue (
905 [["set_recovery_proc"; "true"];
906 ["get_recovery_proc"]])],
907 "enable or disable the recovery process",
909 If this is called with the parameter C<false> then
910 C<guestfs_launch> does not create a recovery process. The
911 purpose of the recovery process is to stop runaway qemu
912 processes in the case where the main program aborts abruptly.
914 This only has any effect if called before C<guestfs_launch>,
915 and the default is true.
917 About the only time when you would want to disable this is
918 if the main process will fork itself into the background
919 (\"daemonize\" itself). In this case the recovery process
920 thinks that the main program has disappeared and so kills
921 qemu, which is not very helpful.");
923 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
925 "get recovery process enabled flag",
927 Return the recovery process enabled flag.");
929 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
931 "add a drive specifying the QEMU block emulation to use",
933 This is the same as C<guestfs_add_drive> but it allows you
934 to specify the QEMU interface emulation to use at run time.");
936 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
938 "add a drive read-only specifying the QEMU block emulation to use",
940 This is the same as C<guestfs_add_drive_ro> but it allows you
941 to specify the QEMU interface emulation to use at run time.");
945 (* daemon_functions are any functions which cause some action
946 * to take place in the daemon.
949 let daemon_functions = [
950 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
951 [InitEmpty, Always, TestOutput (
952 [["part_disk"; "/dev/sda"; "mbr"];
953 ["mkfs"; "ext2"; "/dev/sda1"];
954 ["mount"; "/dev/sda1"; "/"];
955 ["write"; "/new"; "new file contents"];
956 ["cat"; "/new"]], "new file contents")],
957 "mount a guest disk at a position in the filesystem",
959 Mount a guest disk at a position in the filesystem. Block devices
960 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
961 the guest. If those block devices contain partitions, they will have
962 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
965 The rules are the same as for L<mount(2)>: A filesystem must
966 first be mounted on C</> before others can be mounted. Other
967 filesystems can only be mounted on directories which already
970 The mounted filesystem is writable, if we have sufficient permissions
971 on the underlying device.
974 When you use this call, the filesystem options C<sync> and C<noatime>
975 are set implicitly. This was originally done because we thought it
976 would improve reliability, but it turns out that I<-o sync> has a
977 very large negative performance impact and negligible effect on
978 reliability. Therefore we recommend that you avoid using
979 C<guestfs_mount> in any code that needs performance, and instead
980 use C<guestfs_mount_options> (use an empty string for the first
981 parameter if you don't want any options).");
983 ("sync", (RErr, []), 2, [],
984 [ InitEmpty, Always, TestRun [["sync"]]],
985 "sync disks, writes are flushed through to the disk image",
987 This syncs the disk, so that any writes are flushed through to the
988 underlying disk image.
990 You should always call this if you have modified a disk image, before
991 closing the handle.");
993 ("touch", (RErr, [Pathname "path"]), 3, [],
994 [InitBasicFS, Always, TestOutputTrue (
996 ["exists"; "/new"]])],
997 "update file timestamps or create a new file",
999 Touch acts like the L<touch(1)> command. It can be used to
1000 update the timestamps on a file, or, if the file does not exist,
1001 to create a new zero-length file.
1003 This command only works on regular files, and will fail on other
1004 file types such as directories, symbolic links, block special etc.");
1006 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
1007 [InitISOFS, Always, TestOutput (
1008 [["cat"; "/known-2"]], "abcdef\n")],
1009 "list the contents of a file",
1011 Return the contents of the file named C<path>.
1013 Note that this function cannot correctly handle binary files
1014 (specifically, files containing C<\\0> character which is treated
1015 as end of string). For those you need to use the C<guestfs_read_file>
1016 or C<guestfs_download> functions which have a more complex interface.");
1018 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1019 [], (* XXX Tricky to test because it depends on the exact format
1020 * of the 'ls -l' command, which changes between F10 and F11.
1022 "list the files in a directory (long format)",
1024 List the files in C<directory> (relative to the root directory,
1025 there is no cwd) in the format of 'ls -la'.
1027 This command is mostly useful for interactive sessions. It
1028 is I<not> intended that you try to parse the output string.");
1030 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1031 [InitBasicFS, Always, TestOutputList (
1033 ["touch"; "/newer"];
1034 ["touch"; "/newest"];
1035 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1036 "list the files in a directory",
1038 List the files in C<directory> (relative to the root directory,
1039 there is no cwd). The '.' and '..' entries are not returned, but
1040 hidden files are shown.
1042 This command is mostly useful for interactive sessions. Programs
1043 should probably use C<guestfs_readdir> instead.");
1045 ("list_devices", (RStringList "devices", []), 7, [],
1046 [InitEmpty, Always, TestOutputListOfDevices (
1047 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1048 "list the block devices",
1050 List all the block devices.
1052 The full block device names are returned, eg. C</dev/sda>");
1054 ("list_partitions", (RStringList "partitions", []), 8, [],
1055 [InitBasicFS, Always, TestOutputListOfDevices (
1056 [["list_partitions"]], ["/dev/sda1"]);
1057 InitEmpty, Always, TestOutputListOfDevices (
1058 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1059 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1060 "list the partitions",
1062 List all the partitions detected on all block devices.
1064 The full partition device names are returned, eg. C</dev/sda1>
1066 This does not return logical volumes. For that you will need to
1067 call C<guestfs_lvs>.");
1069 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1070 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1071 [["pvs"]], ["/dev/sda1"]);
1072 InitEmpty, Always, TestOutputListOfDevices (
1073 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1074 ["pvcreate"; "/dev/sda1"];
1075 ["pvcreate"; "/dev/sda2"];
1076 ["pvcreate"; "/dev/sda3"];
1077 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1078 "list the LVM physical volumes (PVs)",
1080 List all the physical volumes detected. This is the equivalent
1081 of the L<pvs(8)> command.
1083 This returns a list of just the device names that contain
1084 PVs (eg. C</dev/sda2>).
1086 See also C<guestfs_pvs_full>.");
1088 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1089 [InitBasicFSonLVM, Always, TestOutputList (
1091 InitEmpty, Always, TestOutputList (
1092 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1093 ["pvcreate"; "/dev/sda1"];
1094 ["pvcreate"; "/dev/sda2"];
1095 ["pvcreate"; "/dev/sda3"];
1096 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1097 ["vgcreate"; "VG2"; "/dev/sda3"];
1098 ["vgs"]], ["VG1"; "VG2"])],
1099 "list the LVM volume groups (VGs)",
1101 List all the volumes groups detected. This is the equivalent
1102 of the L<vgs(8)> command.
1104 This returns a list of just the volume group names that were
1105 detected (eg. C<VolGroup00>).
1107 See also C<guestfs_vgs_full>.");
1109 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1110 [InitBasicFSonLVM, Always, TestOutputList (
1111 [["lvs"]], ["/dev/VG/LV"]);
1112 InitEmpty, Always, TestOutputList (
1113 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1114 ["pvcreate"; "/dev/sda1"];
1115 ["pvcreate"; "/dev/sda2"];
1116 ["pvcreate"; "/dev/sda3"];
1117 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1118 ["vgcreate"; "VG2"; "/dev/sda3"];
1119 ["lvcreate"; "LV1"; "VG1"; "50"];
1120 ["lvcreate"; "LV2"; "VG1"; "50"];
1121 ["lvcreate"; "LV3"; "VG2"; "50"];
1122 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1123 "list the LVM logical volumes (LVs)",
1125 List all the logical volumes detected. This is the equivalent
1126 of the L<lvs(8)> command.
1128 This returns a list of the logical volume device names
1129 (eg. C</dev/VolGroup00/LogVol00>).
1131 See also C<guestfs_lvs_full>.");
1133 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1134 [], (* XXX how to test? *)
1135 "list the LVM physical volumes (PVs)",
1137 List all the physical volumes detected. This is the equivalent
1138 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1140 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1141 [], (* XXX how to test? *)
1142 "list the LVM volume groups (VGs)",
1144 List all the volumes groups detected. This is the equivalent
1145 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1147 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1148 [], (* XXX how to test? *)
1149 "list the LVM logical volumes (LVs)",
1151 List all the logical volumes detected. This is the equivalent
1152 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1154 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1155 [InitISOFS, Always, TestOutputList (
1156 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1157 InitISOFS, Always, TestOutputList (
1158 [["read_lines"; "/empty"]], [])],
1159 "read file as lines",
1161 Return the contents of the file named C<path>.
1163 The file contents are returned as a list of lines. Trailing
1164 C<LF> and C<CRLF> character sequences are I<not> returned.
1166 Note that this function cannot correctly handle binary files
1167 (specifically, files containing C<\\0> character which is treated
1168 as end of line). For those you need to use the C<guestfs_read_file>
1169 function which has a more complex interface.");
1171 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1172 [], (* XXX Augeas code needs tests. *)
1173 "create a new Augeas handle",
1175 Create a new Augeas handle for editing configuration files.
1176 If there was any previous Augeas handle associated with this
1177 guestfs session, then it is closed.
1179 You must call this before using any other C<guestfs_aug_*>
1182 C<root> is the filesystem root. C<root> must not be NULL,
1185 The flags are the same as the flags defined in
1186 E<lt>augeas.hE<gt>, the logical I<or> of the following
1191 =item C<AUG_SAVE_BACKUP> = 1
1193 Keep the original file with a C<.augsave> extension.
1195 =item C<AUG_SAVE_NEWFILE> = 2
1197 Save changes into a file with extension C<.augnew>, and
1198 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1200 =item C<AUG_TYPE_CHECK> = 4
1202 Typecheck lenses (can be expensive).
1204 =item C<AUG_NO_STDINC> = 8
1206 Do not use standard load path for modules.
1208 =item C<AUG_SAVE_NOOP> = 16
1210 Make save a no-op, just record what would have been changed.
1212 =item C<AUG_NO_LOAD> = 32
1214 Do not load the tree in C<guestfs_aug_init>.
1218 To close the handle, you can call C<guestfs_aug_close>.
1220 To find out more about Augeas, see L<http://augeas.net/>.");
1222 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1223 [], (* XXX Augeas code needs tests. *)
1224 "close the current Augeas handle",
1226 Close the current Augeas handle and free up any resources
1227 used by it. After calling this, you have to call
1228 C<guestfs_aug_init> again before you can use any other
1229 Augeas functions.");
1231 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1232 [], (* XXX Augeas code needs tests. *)
1233 "define an Augeas variable",
1235 Defines an Augeas variable C<name> whose value is the result
1236 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1239 On success this returns the number of nodes in C<expr>, or
1240 C<0> if C<expr> evaluates to something which is not a nodeset.");
1242 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1243 [], (* XXX Augeas code needs tests. *)
1244 "define an Augeas node",
1246 Defines a variable C<name> whose value is the result of
1249 If C<expr> evaluates to an empty nodeset, a node is created,
1250 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1251 C<name> will be the nodeset containing that single node.
1253 On success this returns a pair containing the
1254 number of nodes in the nodeset, and a boolean flag
1255 if a node was created.");
1257 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1258 [], (* XXX Augeas code needs tests. *)
1259 "look up the value of an Augeas path",
1261 Look up the value associated with C<path>. If C<path>
1262 matches exactly one node, the C<value> is returned.");
1264 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1265 [], (* XXX Augeas code needs tests. *)
1266 "set Augeas path to value",
1268 Set the value associated with C<path> to C<val>.
1270 In the Augeas API, it is possible to clear a node by setting
1271 the value to NULL. Due to an oversight in the libguestfs API
1272 you cannot do that with this call. Instead you must use the
1273 C<guestfs_aug_clear> call.");
1275 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1276 [], (* XXX Augeas code needs tests. *)
1277 "insert a sibling Augeas node",
1279 Create a new sibling C<label> for C<path>, inserting it into
1280 the tree before or after C<path> (depending on the boolean
1283 C<path> must match exactly one existing node in the tree, and
1284 C<label> must be a label, ie. not contain C</>, C<*> or end
1285 with a bracketed index C<[N]>.");
1287 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1288 [], (* XXX Augeas code needs tests. *)
1289 "remove an Augeas path",
1291 Remove C<path> and all of its children.
1293 On success this returns the number of entries which were removed.");
1295 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1296 [], (* XXX Augeas code needs tests. *)
1299 Move the node C<src> to C<dest>. C<src> must match exactly
1300 one node. C<dest> is overwritten if it exists.");
1302 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1303 [], (* XXX Augeas code needs tests. *)
1304 "return Augeas nodes which match augpath",
1306 Returns a list of paths which match the path expression C<path>.
1307 The returned paths are sufficiently qualified so that they match
1308 exactly one node in the current tree.");
1310 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1311 [], (* XXX Augeas code needs tests. *)
1312 "write all pending Augeas changes to disk",
1314 This writes all pending changes to disk.
1316 The flags which were passed to C<guestfs_aug_init> affect exactly
1317 how files are saved.");
1319 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1320 [], (* XXX Augeas code needs tests. *)
1321 "load files into the tree",
1323 Load files into the tree.
1325 See C<aug_load> in the Augeas documentation for the full gory
1328 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1329 [], (* XXX Augeas code needs tests. *)
1330 "list Augeas nodes under augpath",
1332 This is just a shortcut for listing C<guestfs_aug_match>
1333 C<path/*> and sorting the resulting nodes into alphabetical order.");
1335 ("rm", (RErr, [Pathname "path"]), 29, [],
1336 [InitBasicFS, Always, TestRun
1339 InitBasicFS, Always, TestLastFail
1341 InitBasicFS, Always, TestLastFail
1346 Remove the single file C<path>.");
1348 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1349 [InitBasicFS, Always, TestRun
1352 InitBasicFS, Always, TestLastFail
1353 [["rmdir"; "/new"]];
1354 InitBasicFS, Always, TestLastFail
1356 ["rmdir"; "/new"]]],
1357 "remove a directory",
1359 Remove the single directory C<path>.");
1361 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1362 [InitBasicFS, Always, TestOutputFalse
1364 ["mkdir"; "/new/foo"];
1365 ["touch"; "/new/foo/bar"];
1367 ["exists"; "/new"]]],
1368 "remove a file or directory recursively",
1370 Remove the file or directory C<path>, recursively removing the
1371 contents if its a directory. This is like the C<rm -rf> shell
1374 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1375 [InitBasicFS, Always, TestOutputTrue
1377 ["is_dir"; "/new"]];
1378 InitBasicFS, Always, TestLastFail
1379 [["mkdir"; "/new/foo/bar"]]],
1380 "create a directory",
1382 Create a directory named C<path>.");
1384 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1385 [InitBasicFS, Always, TestOutputTrue
1386 [["mkdir_p"; "/new/foo/bar"];
1387 ["is_dir"; "/new/foo/bar"]];
1388 InitBasicFS, Always, TestOutputTrue
1389 [["mkdir_p"; "/new/foo/bar"];
1390 ["is_dir"; "/new/foo"]];
1391 InitBasicFS, Always, TestOutputTrue
1392 [["mkdir_p"; "/new/foo/bar"];
1393 ["is_dir"; "/new"]];
1394 (* Regression tests for RHBZ#503133: *)
1395 InitBasicFS, Always, TestRun
1397 ["mkdir_p"; "/new"]];
1398 InitBasicFS, Always, TestLastFail
1400 ["mkdir_p"; "/new"]]],
1401 "create a directory and parents",
1403 Create a directory named C<path>, creating any parent directories
1404 as necessary. This is like the C<mkdir -p> shell command.");
1406 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1407 [], (* XXX Need stat command to test *)
1410 Change the mode (permissions) of C<path> to C<mode>. Only
1411 numeric modes are supported.
1413 I<Note>: When using this command from guestfish, C<mode>
1414 by default would be decimal, unless you prefix it with
1415 C<0> to get octal, ie. use C<0700> not C<700>.
1417 The mode actually set is affected by the umask.");
1419 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1420 [], (* XXX Need stat command to test *)
1421 "change file owner and group",
1423 Change the file owner to C<owner> and group to C<group>.
1425 Only numeric uid and gid are supported. If you want to use
1426 names, you will need to locate and parse the password file
1427 yourself (Augeas support makes this relatively easy).");
1429 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1430 [InitISOFS, Always, TestOutputTrue (
1431 [["exists"; "/empty"]]);
1432 InitISOFS, Always, TestOutputTrue (
1433 [["exists"; "/directory"]])],
1434 "test if file or directory exists",
1436 This returns C<true> if and only if there is a file, directory
1437 (or anything) with the given C<path> name.
1439 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1441 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1442 [InitISOFS, Always, TestOutputTrue (
1443 [["is_file"; "/known-1"]]);
1444 InitISOFS, Always, TestOutputFalse (
1445 [["is_file"; "/directory"]])],
1446 "test if file exists",
1448 This returns C<true> if and only if there is a file
1449 with the given C<path> name. Note that it returns false for
1450 other objects like directories.
1452 See also C<guestfs_stat>.");
1454 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1455 [InitISOFS, Always, TestOutputFalse (
1456 [["is_dir"; "/known-3"]]);
1457 InitISOFS, Always, TestOutputTrue (
1458 [["is_dir"; "/directory"]])],
1459 "test if file exists",
1461 This returns C<true> if and only if there is a directory
1462 with the given C<path> name. Note that it returns false for
1463 other objects like files.
1465 See also C<guestfs_stat>.");
1467 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1468 [InitEmpty, Always, TestOutputListOfDevices (
1469 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1470 ["pvcreate"; "/dev/sda1"];
1471 ["pvcreate"; "/dev/sda2"];
1472 ["pvcreate"; "/dev/sda3"];
1473 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1474 "create an LVM physical volume",
1476 This creates an LVM physical volume on the named C<device>,
1477 where C<device> should usually be a partition name such
1480 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1481 [InitEmpty, Always, TestOutputList (
1482 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1483 ["pvcreate"; "/dev/sda1"];
1484 ["pvcreate"; "/dev/sda2"];
1485 ["pvcreate"; "/dev/sda3"];
1486 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1487 ["vgcreate"; "VG2"; "/dev/sda3"];
1488 ["vgs"]], ["VG1"; "VG2"])],
1489 "create an LVM volume group",
1491 This creates an LVM volume group called C<volgroup>
1492 from the non-empty list of physical volumes C<physvols>.");
1494 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1495 [InitEmpty, Always, TestOutputList (
1496 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1497 ["pvcreate"; "/dev/sda1"];
1498 ["pvcreate"; "/dev/sda2"];
1499 ["pvcreate"; "/dev/sda3"];
1500 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1501 ["vgcreate"; "VG2"; "/dev/sda3"];
1502 ["lvcreate"; "LV1"; "VG1"; "50"];
1503 ["lvcreate"; "LV2"; "VG1"; "50"];
1504 ["lvcreate"; "LV3"; "VG2"; "50"];
1505 ["lvcreate"; "LV4"; "VG2"; "50"];
1506 ["lvcreate"; "LV5"; "VG2"; "50"];
1508 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1509 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1510 "create an LVM logical volume",
1512 This creates an LVM logical volume called C<logvol>
1513 on the volume group C<volgroup>, with C<size> megabytes.");
1515 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1516 [InitEmpty, Always, TestOutput (
1517 [["part_disk"; "/dev/sda"; "mbr"];
1518 ["mkfs"; "ext2"; "/dev/sda1"];
1519 ["mount_options"; ""; "/dev/sda1"; "/"];
1520 ["write"; "/new"; "new file contents"];
1521 ["cat"; "/new"]], "new file contents")],
1522 "make a filesystem",
1524 This creates a filesystem on C<device> (usually a partition
1525 or LVM logical volume). The filesystem type is C<fstype>, for
1528 ("sfdisk", (RErr, [Device "device";
1529 Int "cyls"; Int "heads"; Int "sectors";
1530 StringList "lines"]), 43, [DangerWillRobinson],
1532 "create partitions on a block device",
1534 This is a direct interface to the L<sfdisk(8)> program for creating
1535 partitions on block devices.
1537 C<device> should be a block device, for example C</dev/sda>.
1539 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1540 and sectors on the device, which are passed directly to sfdisk as
1541 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1542 of these, then the corresponding parameter is omitted. Usually for
1543 'large' disks, you can just pass C<0> for these, but for small
1544 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1545 out the right geometry and you will need to tell it.
1547 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1548 information refer to the L<sfdisk(8)> manpage.
1550 To create a single partition occupying the whole disk, you would
1551 pass C<lines> as a single element list, when the single element being
1552 the string C<,> (comma).
1554 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1555 C<guestfs_part_init>");
1557 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1558 (* Regression test for RHBZ#597135. *)
1559 [InitBasicFS, Always, TestLastFail
1560 [["write_file"; "/new"; "abc"; "10000"]]],
1563 This call creates a file called C<path>. The contents of the
1564 file is the string C<content> (which can contain any 8 bit data),
1565 with length C<size>.
1567 As a special case, if C<size> is C<0>
1568 then the length is calculated using C<strlen> (so in this case
1569 the content cannot contain embedded ASCII NULs).
1571 I<NB.> Owing to a bug, writing content containing ASCII NUL
1572 characters does I<not> work, even if the length is specified.");
1574 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1575 [InitEmpty, Always, TestOutputListOfDevices (
1576 [["part_disk"; "/dev/sda"; "mbr"];
1577 ["mkfs"; "ext2"; "/dev/sda1"];
1578 ["mount_options"; ""; "/dev/sda1"; "/"];
1579 ["mounts"]], ["/dev/sda1"]);
1580 InitEmpty, Always, TestOutputList (
1581 [["part_disk"; "/dev/sda"; "mbr"];
1582 ["mkfs"; "ext2"; "/dev/sda1"];
1583 ["mount_options"; ""; "/dev/sda1"; "/"];
1586 "unmount a filesystem",
1588 This unmounts the given filesystem. The filesystem may be
1589 specified either by its mountpoint (path) or the device which
1590 contains the filesystem.");
1592 ("mounts", (RStringList "devices", []), 46, [],
1593 [InitBasicFS, Always, TestOutputListOfDevices (
1594 [["mounts"]], ["/dev/sda1"])],
1595 "show mounted filesystems",
1597 This returns the list of currently mounted filesystems. It returns
1598 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1600 Some internal mounts are not shown.
1602 See also: C<guestfs_mountpoints>");
1604 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1605 [InitBasicFS, Always, TestOutputList (
1608 (* check that umount_all can unmount nested mounts correctly: *)
1609 InitEmpty, Always, TestOutputList (
1610 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1611 ["mkfs"; "ext2"; "/dev/sda1"];
1612 ["mkfs"; "ext2"; "/dev/sda2"];
1613 ["mkfs"; "ext2"; "/dev/sda3"];
1614 ["mount_options"; ""; "/dev/sda1"; "/"];
1616 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1617 ["mkdir"; "/mp1/mp2"];
1618 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1619 ["mkdir"; "/mp1/mp2/mp3"];
1622 "unmount all filesystems",
1624 This unmounts all mounted filesystems.
1626 Some internal mounts are not unmounted by this call.");
1628 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1630 "remove all LVM LVs, VGs and PVs",
1632 This command removes all LVM logical volumes, volume groups
1633 and physical volumes.");
1635 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1636 [InitISOFS, Always, TestOutput (
1637 [["file"; "/empty"]], "empty");
1638 InitISOFS, Always, TestOutput (
1639 [["file"; "/known-1"]], "ASCII text");
1640 InitISOFS, Always, TestLastFail (
1641 [["file"; "/notexists"]]);
1642 InitISOFS, Always, TestOutput (
1643 [["file"; "/abssymlink"]], "symbolic link");
1644 InitISOFS, Always, TestOutput (
1645 [["file"; "/directory"]], "directory")],
1646 "determine file type",
1648 This call uses the standard L<file(1)> command to determine
1649 the type or contents of the file.
1651 This call will also transparently look inside various types
1654 The exact command which runs is C<file -zb path>. Note in
1655 particular that the filename is not prepended to the output
1658 This command can also be used on C</dev/> devices
1659 (and partitions, LV names). You can for example use this
1660 to determine if a device contains a filesystem, although
1661 it's usually better to use C<guestfs_vfs_type>.
1663 If the C<path> does not begin with C</dev/> then
1664 this command only works for the content of regular files.
1665 For other file types (directory, symbolic link etc) it
1666 will just return the string C<directory> etc.");
1668 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1669 [InitBasicFS, Always, TestOutput (
1670 [["upload"; "test-command"; "/test-command"];
1671 ["chmod"; "0o755"; "/test-command"];
1672 ["command"; "/test-command 1"]], "Result1");
1673 InitBasicFS, Always, TestOutput (
1674 [["upload"; "test-command"; "/test-command"];
1675 ["chmod"; "0o755"; "/test-command"];
1676 ["command"; "/test-command 2"]], "Result2\n");
1677 InitBasicFS, Always, TestOutput (
1678 [["upload"; "test-command"; "/test-command"];
1679 ["chmod"; "0o755"; "/test-command"];
1680 ["command"; "/test-command 3"]], "\nResult3");
1681 InitBasicFS, Always, TestOutput (
1682 [["upload"; "test-command"; "/test-command"];
1683 ["chmod"; "0o755"; "/test-command"];
1684 ["command"; "/test-command 4"]], "\nResult4\n");
1685 InitBasicFS, Always, TestOutput (
1686 [["upload"; "test-command"; "/test-command"];
1687 ["chmod"; "0o755"; "/test-command"];
1688 ["command"; "/test-command 5"]], "\nResult5\n\n");
1689 InitBasicFS, Always, TestOutput (
1690 [["upload"; "test-command"; "/test-command"];
1691 ["chmod"; "0o755"; "/test-command"];
1692 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1693 InitBasicFS, Always, TestOutput (
1694 [["upload"; "test-command"; "/test-command"];
1695 ["chmod"; "0o755"; "/test-command"];
1696 ["command"; "/test-command 7"]], "");
1697 InitBasicFS, Always, TestOutput (
1698 [["upload"; "test-command"; "/test-command"];
1699 ["chmod"; "0o755"; "/test-command"];
1700 ["command"; "/test-command 8"]], "\n");
1701 InitBasicFS, Always, TestOutput (
1702 [["upload"; "test-command"; "/test-command"];
1703 ["chmod"; "0o755"; "/test-command"];
1704 ["command"; "/test-command 9"]], "\n\n");
1705 InitBasicFS, Always, TestOutput (
1706 [["upload"; "test-command"; "/test-command"];
1707 ["chmod"; "0o755"; "/test-command"];
1708 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1709 InitBasicFS, Always, TestOutput (
1710 [["upload"; "test-command"; "/test-command"];
1711 ["chmod"; "0o755"; "/test-command"];
1712 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1713 InitBasicFS, Always, TestLastFail (
1714 [["upload"; "test-command"; "/test-command"];
1715 ["chmod"; "0o755"; "/test-command"];
1716 ["command"; "/test-command"]])],
1717 "run a command from the guest filesystem",
1719 This call runs a command from the guest filesystem. The
1720 filesystem must be mounted, and must contain a compatible
1721 operating system (ie. something Linux, with the same
1722 or compatible processor architecture).
1724 The single parameter is an argv-style list of arguments.
1725 The first element is the name of the program to run.
1726 Subsequent elements are parameters. The list must be
1727 non-empty (ie. must contain a program name). Note that
1728 the command runs directly, and is I<not> invoked via
1729 the shell (see C<guestfs_sh>).
1731 The return value is anything printed to I<stdout> by
1734 If the command returns a non-zero exit status, then
1735 this function returns an error message. The error message
1736 string is the content of I<stderr> from the command.
1738 The C<$PATH> environment variable will contain at least
1739 C</usr/bin> and C</bin>. If you require a program from
1740 another location, you should provide the full path in the
1743 Shared libraries and data files required by the program
1744 must be available on filesystems which are mounted in the
1745 correct places. It is the caller's responsibility to ensure
1746 all filesystems that are needed are mounted at the right
1749 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1750 [InitBasicFS, Always, TestOutputList (
1751 [["upload"; "test-command"; "/test-command"];
1752 ["chmod"; "0o755"; "/test-command"];
1753 ["command_lines"; "/test-command 1"]], ["Result1"]);
1754 InitBasicFS, Always, TestOutputList (
1755 [["upload"; "test-command"; "/test-command"];
1756 ["chmod"; "0o755"; "/test-command"];
1757 ["command_lines"; "/test-command 2"]], ["Result2"]);
1758 InitBasicFS, Always, TestOutputList (
1759 [["upload"; "test-command"; "/test-command"];
1760 ["chmod"; "0o755"; "/test-command"];
1761 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1762 InitBasicFS, Always, TestOutputList (
1763 [["upload"; "test-command"; "/test-command"];
1764 ["chmod"; "0o755"; "/test-command"];
1765 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1766 InitBasicFS, Always, TestOutputList (
1767 [["upload"; "test-command"; "/test-command"];
1768 ["chmod"; "0o755"; "/test-command"];
1769 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1770 InitBasicFS, Always, TestOutputList (
1771 [["upload"; "test-command"; "/test-command"];
1772 ["chmod"; "0o755"; "/test-command"];
1773 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1774 InitBasicFS, Always, TestOutputList (
1775 [["upload"; "test-command"; "/test-command"];
1776 ["chmod"; "0o755"; "/test-command"];
1777 ["command_lines"; "/test-command 7"]], []);
1778 InitBasicFS, Always, TestOutputList (
1779 [["upload"; "test-command"; "/test-command"];
1780 ["chmod"; "0o755"; "/test-command"];
1781 ["command_lines"; "/test-command 8"]], [""]);
1782 InitBasicFS, Always, TestOutputList (
1783 [["upload"; "test-command"; "/test-command"];
1784 ["chmod"; "0o755"; "/test-command"];
1785 ["command_lines"; "/test-command 9"]], ["";""]);
1786 InitBasicFS, Always, TestOutputList (
1787 [["upload"; "test-command"; "/test-command"];
1788 ["chmod"; "0o755"; "/test-command"];
1789 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1790 InitBasicFS, Always, TestOutputList (
1791 [["upload"; "test-command"; "/test-command"];
1792 ["chmod"; "0o755"; "/test-command"];
1793 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1794 "run a command, returning lines",
1796 This is the same as C<guestfs_command>, but splits the
1797 result into a list of lines.
1799 See also: C<guestfs_sh_lines>");
1801 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1802 [InitISOFS, Always, TestOutputStruct (
1803 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1804 "get file information",
1806 Returns file information for the given C<path>.
1808 This is the same as the C<stat(2)> system call.");
1810 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1811 [InitISOFS, Always, TestOutputStruct (
1812 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1813 "get file information for a symbolic link",
1815 Returns file information for the given C<path>.
1817 This is the same as C<guestfs_stat> except that if C<path>
1818 is a symbolic link, then the link is stat-ed, not the file it
1821 This is the same as the C<lstat(2)> system call.");
1823 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1824 [InitISOFS, Always, TestOutputStruct (
1825 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1826 "get file system statistics",
1828 Returns file system statistics for any mounted file system.
1829 C<path> should be a file or directory in the mounted file system
1830 (typically it is the mount point itself, but it doesn't need to be).
1832 This is the same as the C<statvfs(2)> system call.");
1834 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1836 "get ext2/ext3/ext4 superblock details",
1838 This returns the contents of the ext2, ext3 or ext4 filesystem
1839 superblock on C<device>.
1841 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1842 manpage for more details. The list of fields returned isn't
1843 clearly defined, and depends on both the version of C<tune2fs>
1844 that libguestfs was built against, and the filesystem itself.");
1846 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1847 [InitEmpty, Always, TestOutputTrue (
1848 [["blockdev_setro"; "/dev/sda"];
1849 ["blockdev_getro"; "/dev/sda"]])],
1850 "set block device to read-only",
1852 Sets the block device named C<device> to read-only.
1854 This uses the L<blockdev(8)> command.");
1856 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1857 [InitEmpty, Always, TestOutputFalse (
1858 [["blockdev_setrw"; "/dev/sda"];
1859 ["blockdev_getro"; "/dev/sda"]])],
1860 "set block device to read-write",
1862 Sets the block device named C<device> to read-write.
1864 This uses the L<blockdev(8)> command.");
1866 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1867 [InitEmpty, Always, TestOutputTrue (
1868 [["blockdev_setro"; "/dev/sda"];
1869 ["blockdev_getro"; "/dev/sda"]])],
1870 "is block device set to read-only",
1872 Returns a boolean indicating if the block device is read-only
1873 (true if read-only, false if not).
1875 This uses the L<blockdev(8)> command.");
1877 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1878 [InitEmpty, Always, TestOutputInt (
1879 [["blockdev_getss"; "/dev/sda"]], 512)],
1880 "get sectorsize of block device",
1882 This returns the size of sectors on a block device.
1883 Usually 512, but can be larger for modern devices.
1885 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1888 This uses the L<blockdev(8)> command.");
1890 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1891 [InitEmpty, Always, TestOutputInt (
1892 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1893 "get blocksize of block device",
1895 This returns the block size of a device.
1897 (Note this is different from both I<size in blocks> and
1898 I<filesystem block size>).
1900 This uses the L<blockdev(8)> command.");
1902 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1904 "set blocksize of block device",
1906 This sets the block size of a device.
1908 (Note this is different from both I<size in blocks> and
1909 I<filesystem block size>).
1911 This uses the L<blockdev(8)> command.");
1913 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1914 [InitEmpty, Always, TestOutputInt (
1915 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1916 "get total size of device in 512-byte sectors",
1918 This returns the size of the device in units of 512-byte sectors
1919 (even if the sectorsize isn't 512 bytes ... weird).
1921 See also C<guestfs_blockdev_getss> for the real sector size of
1922 the device, and C<guestfs_blockdev_getsize64> for the more
1923 useful I<size in bytes>.
1925 This uses the L<blockdev(8)> command.");
1927 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1928 [InitEmpty, Always, TestOutputInt (
1929 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1930 "get total size of device in bytes",
1932 This returns the size of the device in bytes.
1934 See also C<guestfs_blockdev_getsz>.
1936 This uses the L<blockdev(8)> command.");
1938 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1939 [InitEmpty, Always, TestRun
1940 [["blockdev_flushbufs"; "/dev/sda"]]],
1941 "flush device buffers",
1943 This tells the kernel to flush internal buffers associated
1946 This uses the L<blockdev(8)> command.");
1948 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1949 [InitEmpty, Always, TestRun
1950 [["blockdev_rereadpt"; "/dev/sda"]]],
1951 "reread partition table",
1953 Reread the partition table on C<device>.
1955 This uses the L<blockdev(8)> command.");
1957 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1958 [InitBasicFS, Always, TestOutput (
1959 (* Pick a file from cwd which isn't likely to change. *)
1960 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1961 ["checksum"; "md5"; "/COPYING.LIB"]],
1962 Digest.to_hex (Digest.file "COPYING.LIB"))],
1963 "upload a file from the local machine",
1965 Upload local file C<filename> to C<remotefilename> on the
1968 C<filename> can also be a named pipe.
1970 See also C<guestfs_download>.");
1972 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1973 [InitBasicFS, Always, TestOutput (
1974 (* Pick a file from cwd which isn't likely to change. *)
1975 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1976 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1977 ["upload"; "testdownload.tmp"; "/upload"];
1978 ["checksum"; "md5"; "/upload"]],
1979 Digest.to_hex (Digest.file "COPYING.LIB"))],
1980 "download a file to the local machine",
1982 Download file C<remotefilename> and save it as C<filename>
1983 on the local machine.
1985 C<filename> can also be a named pipe.
1987 See also C<guestfs_upload>, C<guestfs_cat>.");
1989 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1990 [InitISOFS, Always, TestOutput (
1991 [["checksum"; "crc"; "/known-3"]], "2891671662");
1992 InitISOFS, Always, TestLastFail (
1993 [["checksum"; "crc"; "/notexists"]]);
1994 InitISOFS, Always, TestOutput (
1995 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1996 InitISOFS, Always, TestOutput (
1997 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1998 InitISOFS, Always, TestOutput (
1999 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
2000 InitISOFS, Always, TestOutput (
2001 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
2002 InitISOFS, Always, TestOutput (
2003 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
2004 InitISOFS, Always, TestOutput (
2005 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2006 (* Test for RHBZ#579608, absolute symbolic links. *)
2007 InitISOFS, Always, TestOutput (
2008 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2009 "compute MD5, SHAx or CRC checksum of file",
2011 This call computes the MD5, SHAx or CRC checksum of the
2014 The type of checksum to compute is given by the C<csumtype>
2015 parameter which must have one of the following values:
2021 Compute the cyclic redundancy check (CRC) specified by POSIX
2022 for the C<cksum> command.
2026 Compute the MD5 hash (using the C<md5sum> program).
2030 Compute the SHA1 hash (using the C<sha1sum> program).
2034 Compute the SHA224 hash (using the C<sha224sum> program).
2038 Compute the SHA256 hash (using the C<sha256sum> program).
2042 Compute the SHA384 hash (using the C<sha384sum> program).
2046 Compute the SHA512 hash (using the C<sha512sum> program).
2050 The checksum is returned as a printable string.
2052 To get the checksum for a device, use C<guestfs_checksum_device>.
2054 To get the checksums for many files, use C<guestfs_checksums_out>.");
2056 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2057 [InitBasicFS, Always, TestOutput (
2058 [["tar_in"; "../images/helloworld.tar"; "/"];
2059 ["cat"; "/hello"]], "hello\n")],
2060 "unpack tarfile to directory",
2062 This command uploads and unpacks local file C<tarfile> (an
2063 I<uncompressed> tar file) into C<directory>.
2065 To upload a compressed tarball, use C<guestfs_tgz_in>
2066 or C<guestfs_txz_in>.");
2068 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2070 "pack directory into tarfile",
2072 This command packs the contents of C<directory> and downloads
2073 it to local file C<tarfile>.
2075 To download a compressed tarball, use C<guestfs_tgz_out>
2076 or C<guestfs_txz_out>.");
2078 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2079 [InitBasicFS, Always, TestOutput (
2080 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2081 ["cat"; "/hello"]], "hello\n")],
2082 "unpack compressed tarball to directory",
2084 This command uploads and unpacks local file C<tarball> (a
2085 I<gzip compressed> tar file) into C<directory>.
2087 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2089 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2091 "pack directory into compressed tarball",
2093 This command packs the contents of C<directory> and downloads
2094 it to local file C<tarball>.
2096 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2098 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2099 [InitBasicFS, Always, TestLastFail (
2101 ["mount_ro"; "/dev/sda1"; "/"];
2102 ["touch"; "/new"]]);
2103 InitBasicFS, Always, TestOutput (
2104 [["write"; "/new"; "data"];
2106 ["mount_ro"; "/dev/sda1"; "/"];
2107 ["cat"; "/new"]], "data")],
2108 "mount a guest disk, read-only",
2110 This is the same as the C<guestfs_mount> command, but it
2111 mounts the filesystem with the read-only (I<-o ro>) flag.");
2113 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2115 "mount a guest disk with mount options",
2117 This is the same as the C<guestfs_mount> command, but it
2118 allows you to set the mount options as for the
2119 L<mount(8)> I<-o> flag.
2121 If the C<options> parameter is an empty string, then
2122 no options are passed (all options default to whatever
2123 the filesystem uses).");
2125 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2127 "mount a guest disk with mount options and vfstype",
2129 This is the same as the C<guestfs_mount> command, but it
2130 allows you to set both the mount options and the vfstype
2131 as for the L<mount(8)> I<-o> and I<-t> flags.");
2133 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2135 "debugging and internals",
2137 The C<guestfs_debug> command exposes some internals of
2138 C<guestfsd> (the guestfs daemon) that runs inside the
2141 There is no comprehensive help for this command. You have
2142 to look at the file C<daemon/debug.c> in the libguestfs source
2143 to find out what you can do.");
2145 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2146 [InitEmpty, Always, TestOutputList (
2147 [["part_disk"; "/dev/sda"; "mbr"];
2148 ["pvcreate"; "/dev/sda1"];
2149 ["vgcreate"; "VG"; "/dev/sda1"];
2150 ["lvcreate"; "LV1"; "VG"; "50"];
2151 ["lvcreate"; "LV2"; "VG"; "50"];
2152 ["lvremove"; "/dev/VG/LV1"];
2153 ["lvs"]], ["/dev/VG/LV2"]);
2154 InitEmpty, Always, TestOutputList (
2155 [["part_disk"; "/dev/sda"; "mbr"];
2156 ["pvcreate"; "/dev/sda1"];
2157 ["vgcreate"; "VG"; "/dev/sda1"];
2158 ["lvcreate"; "LV1"; "VG"; "50"];
2159 ["lvcreate"; "LV2"; "VG"; "50"];
2160 ["lvremove"; "/dev/VG"];
2162 InitEmpty, Always, TestOutputList (
2163 [["part_disk"; "/dev/sda"; "mbr"];
2164 ["pvcreate"; "/dev/sda1"];
2165 ["vgcreate"; "VG"; "/dev/sda1"];
2166 ["lvcreate"; "LV1"; "VG"; "50"];
2167 ["lvcreate"; "LV2"; "VG"; "50"];
2168 ["lvremove"; "/dev/VG"];
2170 "remove an LVM logical volume",
2172 Remove an LVM logical volume C<device>, where C<device> is
2173 the path to the LV, such as C</dev/VG/LV>.
2175 You can also remove all LVs in a volume group by specifying
2176 the VG name, C</dev/VG>.");
2178 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2179 [InitEmpty, Always, TestOutputList (
2180 [["part_disk"; "/dev/sda"; "mbr"];
2181 ["pvcreate"; "/dev/sda1"];
2182 ["vgcreate"; "VG"; "/dev/sda1"];
2183 ["lvcreate"; "LV1"; "VG"; "50"];
2184 ["lvcreate"; "LV2"; "VG"; "50"];
2187 InitEmpty, Always, TestOutputList (
2188 [["part_disk"; "/dev/sda"; "mbr"];
2189 ["pvcreate"; "/dev/sda1"];
2190 ["vgcreate"; "VG"; "/dev/sda1"];
2191 ["lvcreate"; "LV1"; "VG"; "50"];
2192 ["lvcreate"; "LV2"; "VG"; "50"];
2195 "remove an LVM volume group",
2197 Remove an LVM volume group C<vgname>, (for example C<VG>).
2199 This also forcibly removes all logical volumes in the volume
2202 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2203 [InitEmpty, Always, TestOutputListOfDevices (
2204 [["part_disk"; "/dev/sda"; "mbr"];
2205 ["pvcreate"; "/dev/sda1"];
2206 ["vgcreate"; "VG"; "/dev/sda1"];
2207 ["lvcreate"; "LV1"; "VG"; "50"];
2208 ["lvcreate"; "LV2"; "VG"; "50"];
2210 ["pvremove"; "/dev/sda1"];
2212 InitEmpty, Always, TestOutputListOfDevices (
2213 [["part_disk"; "/dev/sda"; "mbr"];
2214 ["pvcreate"; "/dev/sda1"];
2215 ["vgcreate"; "VG"; "/dev/sda1"];
2216 ["lvcreate"; "LV1"; "VG"; "50"];
2217 ["lvcreate"; "LV2"; "VG"; "50"];
2219 ["pvremove"; "/dev/sda1"];
2221 InitEmpty, Always, TestOutputListOfDevices (
2222 [["part_disk"; "/dev/sda"; "mbr"];
2223 ["pvcreate"; "/dev/sda1"];
2224 ["vgcreate"; "VG"; "/dev/sda1"];
2225 ["lvcreate"; "LV1"; "VG"; "50"];
2226 ["lvcreate"; "LV2"; "VG"; "50"];
2228 ["pvremove"; "/dev/sda1"];
2230 "remove an LVM physical volume",
2232 This wipes a physical volume C<device> so that LVM will no longer
2235 The implementation uses the C<pvremove> command which refuses to
2236 wipe physical volumes that contain any volume groups, so you have
2237 to remove those first.");
2239 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2240 [InitBasicFS, Always, TestOutput (
2241 [["set_e2label"; "/dev/sda1"; "testlabel"];
2242 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2243 "set the ext2/3/4 filesystem label",
2245 This sets the ext2/3/4 filesystem label of the filesystem on
2246 C<device> to C<label>. Filesystem labels are limited to
2249 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2250 to return the existing label on a filesystem.");
2252 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2254 "get the ext2/3/4 filesystem label",
2256 This returns the ext2/3/4 filesystem label of the filesystem on
2259 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2260 (let uuid = uuidgen () in
2261 [InitBasicFS, Always, TestOutput (
2262 [["set_e2uuid"; "/dev/sda1"; uuid];
2263 ["get_e2uuid"; "/dev/sda1"]], uuid);
2264 InitBasicFS, Always, TestOutput (
2265 [["set_e2uuid"; "/dev/sda1"; "clear"];
2266 ["get_e2uuid"; "/dev/sda1"]], "");
2267 (* We can't predict what UUIDs will be, so just check the commands run. *)
2268 InitBasicFS, Always, TestRun (
2269 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2270 InitBasicFS, Always, TestRun (
2271 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2272 "set the ext2/3/4 filesystem UUID",
2274 This sets the ext2/3/4 filesystem UUID of the filesystem on
2275 C<device> to C<uuid>. The format of the UUID and alternatives
2276 such as C<clear>, C<random> and C<time> are described in the
2277 L<tune2fs(8)> manpage.
2279 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2280 to return the existing UUID of a filesystem.");
2282 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2283 (* Regression test for RHBZ#597112. *)
2284 (let uuid = uuidgen () in
2285 [InitBasicFS, Always, TestOutput (
2286 [["mke2journal"; "1024"; "/dev/sdb"];
2287 ["set_e2uuid"; "/dev/sdb"; uuid];
2288 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2289 "get the ext2/3/4 filesystem UUID",
2291 This returns the ext2/3/4 filesystem UUID of the filesystem on
2294 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2295 [InitBasicFS, Always, TestOutputInt (
2296 [["umount"; "/dev/sda1"];
2297 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2298 InitBasicFS, Always, TestOutputInt (
2299 [["umount"; "/dev/sda1"];
2300 ["zero"; "/dev/sda1"];
2301 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2302 "run the filesystem checker",
2304 This runs the filesystem checker (fsck) on C<device> which
2305 should have filesystem type C<fstype>.
2307 The returned integer is the status. See L<fsck(8)> for the
2308 list of status codes from C<fsck>.
2316 Multiple status codes can be summed together.
2320 A non-zero return code can mean \"success\", for example if
2321 errors have been corrected on the filesystem.
2325 Checking or repairing NTFS volumes is not supported
2330 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2332 ("zero", (RErr, [Device "device"]), 85, [],
2333 [InitBasicFS, Always, TestOutput (
2334 [["umount"; "/dev/sda1"];
2335 ["zero"; "/dev/sda1"];
2336 ["file"; "/dev/sda1"]], "data")],
2337 "write zeroes to the device",
2339 This command writes zeroes over the first few blocks of C<device>.
2341 How many blocks are zeroed isn't specified (but it's I<not> enough
2342 to securely wipe the device). It should be sufficient to remove
2343 any partition tables, filesystem superblocks and so on.
2345 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2347 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2349 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2350 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2352 [InitBasicFS, Always, TestOutputTrue (
2353 [["mkdir_p"; "/boot/grub"];
2354 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2355 ["grub_install"; "/"; "/dev/vda"];
2356 ["is_dir"; "/boot"]])],
2359 This command installs GRUB (the Grand Unified Bootloader) on
2360 C<device>, with the root directory being C<root>.
2362 Note: If grub-install reports the error
2363 \"No suitable drive was found in the generated device map.\"
2364 it may be that you need to create a C</boot/grub/device.map>
2365 file first that contains the mapping between grub device names
2366 and Linux device names. It is usually sufficient to create
2371 replacing C</dev/vda> with the name of the installation device.");
2373 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2374 [InitBasicFS, Always, TestOutput (
2375 [["write"; "/old"; "file content"];
2376 ["cp"; "/old"; "/new"];
2377 ["cat"; "/new"]], "file content");
2378 InitBasicFS, Always, TestOutputTrue (
2379 [["write"; "/old"; "file content"];
2380 ["cp"; "/old"; "/new"];
2381 ["is_file"; "/old"]]);
2382 InitBasicFS, Always, TestOutput (
2383 [["write"; "/old"; "file content"];
2385 ["cp"; "/old"; "/dir/new"];
2386 ["cat"; "/dir/new"]], "file content")],
2389 This copies a file from C<src> to C<dest> where C<dest> is
2390 either a destination filename or destination directory.");
2392 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2393 [InitBasicFS, Always, TestOutput (
2394 [["mkdir"; "/olddir"];
2395 ["mkdir"; "/newdir"];
2396 ["write"; "/olddir/file"; "file content"];
2397 ["cp_a"; "/olddir"; "/newdir"];
2398 ["cat"; "/newdir/olddir/file"]], "file content")],
2399 "copy a file or directory recursively",
2401 This copies a file or directory from C<src> to C<dest>
2402 recursively using the C<cp -a> command.");
2404 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2405 [InitBasicFS, Always, TestOutput (
2406 [["write"; "/old"; "file content"];
2407 ["mv"; "/old"; "/new"];
2408 ["cat"; "/new"]], "file content");
2409 InitBasicFS, Always, TestOutputFalse (
2410 [["write"; "/old"; "file content"];
2411 ["mv"; "/old"; "/new"];
2412 ["is_file"; "/old"]])],
2415 This moves a file from C<src> to C<dest> where C<dest> is
2416 either a destination filename or destination directory.");
2418 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2419 [InitEmpty, Always, TestRun (
2420 [["drop_caches"; "3"]])],
2421 "drop kernel page cache, dentries and inodes",
2423 This instructs the guest kernel to drop its page cache,
2424 and/or dentries and inode caches. The parameter C<whattodrop>
2425 tells the kernel what precisely to drop, see
2426 L<http://linux-mm.org/Drop_Caches>
2428 Setting C<whattodrop> to 3 should drop everything.
2430 This automatically calls L<sync(2)> before the operation,
2431 so that the maximum guest memory is freed.");
2433 ("dmesg", (RString "kmsgs", []), 91, [],
2434 [InitEmpty, Always, TestRun (
2436 "return kernel messages",
2438 This returns the kernel messages (C<dmesg> output) from
2439 the guest kernel. This is sometimes useful for extended
2440 debugging of problems.
2442 Another way to get the same information is to enable
2443 verbose messages with C<guestfs_set_verbose> or by setting
2444 the environment variable C<LIBGUESTFS_DEBUG=1> before
2445 running the program.");
2447 ("ping_daemon", (RErr, []), 92, [],
2448 [InitEmpty, Always, TestRun (
2449 [["ping_daemon"]])],
2450 "ping the guest daemon",
2452 This is a test probe into the guestfs daemon running inside
2453 the qemu subprocess. Calling this function checks that the
2454 daemon responds to the ping message, without affecting the daemon
2455 or attached block device(s) in any other way.");
2457 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2458 [InitBasicFS, Always, TestOutputTrue (
2459 [["write"; "/file1"; "contents of a file"];
2460 ["cp"; "/file1"; "/file2"];
2461 ["equal"; "/file1"; "/file2"]]);
2462 InitBasicFS, Always, TestOutputFalse (
2463 [["write"; "/file1"; "contents of a file"];
2464 ["write"; "/file2"; "contents of another file"];
2465 ["equal"; "/file1"; "/file2"]]);
2466 InitBasicFS, Always, TestLastFail (
2467 [["equal"; "/file1"; "/file2"]])],
2468 "test if two files have equal contents",
2470 This compares the two files C<file1> and C<file2> and returns
2471 true if their content is exactly equal, or false otherwise.
2473 The external L<cmp(1)> program is used for the comparison.");
2475 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2476 [InitISOFS, Always, TestOutputList (
2477 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2478 InitISOFS, Always, TestOutputList (
2479 [["strings"; "/empty"]], []);
2480 (* Test for RHBZ#579608, absolute symbolic links. *)
2481 InitISOFS, Always, TestRun (
2482 [["strings"; "/abssymlink"]])],
2483 "print the printable strings in a file",
2485 This runs the L<strings(1)> command on a file and returns
2486 the list of printable strings found.");
2488 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2489 [InitISOFS, Always, TestOutputList (
2490 [["strings_e"; "b"; "/known-5"]], []);
2491 InitBasicFS, Always, TestOutputList (
2492 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2493 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2494 "print the printable strings in a file",
2496 This is like the C<guestfs_strings> command, but allows you to
2497 specify the encoding of strings that are looked for in
2498 the source file C<path>.
2500 Allowed encodings are:
2506 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2507 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2511 Single 8-bit-byte characters.
2515 16-bit big endian strings such as those encoded in
2516 UTF-16BE or UCS-2BE.
2518 =item l (lower case letter L)
2520 16-bit little endian such as UTF-16LE and UCS-2LE.
2521 This is useful for examining binaries in Windows guests.
2525 32-bit big endian such as UCS-4BE.
2529 32-bit little endian such as UCS-4LE.
2533 The returned strings are transcoded to UTF-8.");
2535 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2536 [InitISOFS, Always, TestOutput (
2537 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2538 (* Test for RHBZ#501888c2 regression which caused large hexdump
2539 * commands to segfault.
2541 InitISOFS, Always, TestRun (
2542 [["hexdump"; "/100krandom"]]);
2543 (* Test for RHBZ#579608, absolute symbolic links. *)
2544 InitISOFS, Always, TestRun (
2545 [["hexdump"; "/abssymlink"]])],
2546 "dump a file in hexadecimal",
2548 This runs C<hexdump -C> on the given C<path>. The result is
2549 the human-readable, canonical hex dump of the file.");
2551 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2552 [InitNone, Always, TestOutput (
2553 [["part_disk"; "/dev/sda"; "mbr"];
2554 ["mkfs"; "ext3"; "/dev/sda1"];
2555 ["mount_options"; ""; "/dev/sda1"; "/"];
2556 ["write"; "/new"; "test file"];
2557 ["umount"; "/dev/sda1"];
2558 ["zerofree"; "/dev/sda1"];
2559 ["mount_options"; ""; "/dev/sda1"; "/"];
2560 ["cat"; "/new"]], "test file")],
2561 "zero unused inodes and disk blocks on ext2/3 filesystem",
2563 This runs the I<zerofree> program on C<device>. This program
2564 claims to zero unused inodes and disk blocks on an ext2/3
2565 filesystem, thus making it possible to compress the filesystem
2568 You should B<not> run this program if the filesystem is
2571 It is possible that using this program can damage the filesystem
2572 or data on the filesystem.");
2574 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2576 "resize an LVM physical volume",
2578 This resizes (expands or shrinks) an existing LVM physical
2579 volume to match the new size of the underlying device.");
2581 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2582 Int "cyls"; Int "heads"; Int "sectors";
2583 String "line"]), 99, [DangerWillRobinson],
2585 "modify a single partition on a block device",
2587 This runs L<sfdisk(8)> option to modify just the single
2588 partition C<n> (note: C<n> counts from 1).
2590 For other parameters, see C<guestfs_sfdisk>. You should usually
2591 pass C<0> for the cyls/heads/sectors parameters.
2593 See also: C<guestfs_part_add>");
2595 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2597 "display the partition table",
2599 This displays the partition table on C<device>, in the
2600 human-readable output of the L<sfdisk(8)> command. It is
2601 not intended to be parsed.
2603 See also: C<guestfs_part_list>");
2605 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2607 "display the kernel geometry",
2609 This displays the kernel's idea of the geometry of C<device>.
2611 The result is in human-readable format, and not designed to
2614 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2616 "display the disk geometry from the partition table",
2618 This displays the disk geometry of C<device> read from the
2619 partition table. Especially in the case where the underlying
2620 block device has been resized, this can be different from the
2621 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2623 The result is in human-readable format, and not designed to
2626 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2628 "activate or deactivate all volume groups",
2630 This command activates or (if C<activate> is false) deactivates
2631 all logical volumes in all volume groups.
2632 If activated, then they are made known to the
2633 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2634 then those devices disappear.
2636 This command is the same as running C<vgchange -a y|n>");
2638 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2640 "activate or deactivate some volume groups",
2642 This command activates or (if C<activate> is false) deactivates
2643 all logical volumes in the listed volume groups C<volgroups>.
2644 If activated, then they are made known to the
2645 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2646 then those devices disappear.
2648 This command is the same as running C<vgchange -a y|n volgroups...>
2650 Note that if C<volgroups> is an empty list then B<all> volume groups
2651 are activated or deactivated.");
2653 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2654 [InitNone, Always, TestOutput (
2655 [["part_disk"; "/dev/sda"; "mbr"];
2656 ["pvcreate"; "/dev/sda1"];
2657 ["vgcreate"; "VG"; "/dev/sda1"];
2658 ["lvcreate"; "LV"; "VG"; "10"];
2659 ["mkfs"; "ext2"; "/dev/VG/LV"];
2660 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2661 ["write"; "/new"; "test content"];
2663 ["lvresize"; "/dev/VG/LV"; "20"];
2664 ["e2fsck_f"; "/dev/VG/LV"];
2665 ["resize2fs"; "/dev/VG/LV"];
2666 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2667 ["cat"; "/new"]], "test content");
2668 InitNone, Always, TestRun (
2669 (* Make an LV smaller to test RHBZ#587484. *)
2670 [["part_disk"; "/dev/sda"; "mbr"];
2671 ["pvcreate"; "/dev/sda1"];
2672 ["vgcreate"; "VG"; "/dev/sda1"];
2673 ["lvcreate"; "LV"; "VG"; "20"];
2674 ["lvresize"; "/dev/VG/LV"; "10"]])],
2675 "resize an LVM logical volume",
2677 This resizes (expands or shrinks) an existing LVM logical
2678 volume to C<mbytes>. When reducing, data in the reduced part
2681 ("resize2fs", (RErr, [Device "device"]), 106, [],
2682 [], (* lvresize tests this *)
2683 "resize an ext2, ext3 or ext4 filesystem",
2685 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2686 the underlying device.
2688 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2689 on the C<device> before calling this command. For unknown reasons
2690 C<resize2fs> sometimes gives an error about this and sometimes not.
2691 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2692 calling this function.");
2694 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2695 [InitBasicFS, Always, TestOutputList (
2696 [["find"; "/"]], ["lost+found"]);
2697 InitBasicFS, Always, TestOutputList (
2701 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2702 InitBasicFS, Always, TestOutputList (
2703 [["mkdir_p"; "/a/b/c"];
2704 ["touch"; "/a/b/c/d"];
2705 ["find"; "/a/b/"]], ["c"; "c/d"])],
2706 "find all files and directories",
2708 This command lists out all files and directories, recursively,
2709 starting at C<directory>. It is essentially equivalent to
2710 running the shell command C<find directory -print> but some
2711 post-processing happens on the output, described below.
2713 This returns a list of strings I<without any prefix>. Thus
2714 if the directory structure was:
2720 then the returned list from C<guestfs_find> C</tmp> would be
2728 If C<directory> is not a directory, then this command returns
2731 The returned list is sorted.
2733 See also C<guestfs_find0>.");
2735 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2736 [], (* lvresize tests this *)
2737 "check an ext2/ext3 filesystem",
2739 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2740 filesystem checker on C<device>, noninteractively (C<-p>),
2741 even if the filesystem appears to be clean (C<-f>).
2743 This command is only needed because of C<guestfs_resize2fs>
2744 (q.v.). Normally you should use C<guestfs_fsck>.");
2746 ("sleep", (RErr, [Int "secs"]), 109, [],
2747 [InitNone, Always, TestRun (
2749 "sleep for some seconds",
2751 Sleep for C<secs> seconds.");
2753 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2754 [InitNone, Always, TestOutputInt (
2755 [["part_disk"; "/dev/sda"; "mbr"];
2756 ["mkfs"; "ntfs"; "/dev/sda1"];
2757 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2758 InitNone, Always, TestOutputInt (
2759 [["part_disk"; "/dev/sda"; "mbr"];
2760 ["mkfs"; "ext2"; "/dev/sda1"];
2761 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2762 "probe NTFS volume",
2764 This command runs the L<ntfs-3g.probe(8)> command which probes
2765 an NTFS C<device> for mountability. (Not all NTFS volumes can
2766 be mounted read-write, and some cannot be mounted at all).
2768 C<rw> is a boolean flag. Set it to true if you want to test
2769 if the volume can be mounted read-write. Set it to false if
2770 you want to test if the volume can be mounted read-only.
2772 The return value is an integer which C<0> if the operation
2773 would succeed, or some non-zero value documented in the
2774 L<ntfs-3g.probe(8)> manual page.");
2776 ("sh", (RString "output", [String "command"]), 111, [],
2777 [], (* XXX needs tests *)
2778 "run a command via the shell",
2780 This call runs a command from the guest filesystem via the
2783 This is like C<guestfs_command>, but passes the command to:
2785 /bin/sh -c \"command\"
2787 Depending on the guest's shell, this usually results in
2788 wildcards being expanded, shell expressions being interpolated
2791 All the provisos about C<guestfs_command> apply to this call.");
2793 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2794 [], (* XXX needs tests *)
2795 "run a command via the shell returning lines",
2797 This is the same as C<guestfs_sh>, but splits the result
2798 into a list of lines.
2800 See also: C<guestfs_command_lines>");
2802 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2803 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2804 * code in stubs.c, since all valid glob patterns must start with "/".
2805 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2807 [InitBasicFS, Always, TestOutputList (
2808 [["mkdir_p"; "/a/b/c"];
2809 ["touch"; "/a/b/c/d"];
2810 ["touch"; "/a/b/c/e"];
2811 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2812 InitBasicFS, Always, TestOutputList (
2813 [["mkdir_p"; "/a/b/c"];
2814 ["touch"; "/a/b/c/d"];
2815 ["touch"; "/a/b/c/e"];
2816 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2817 InitBasicFS, Always, TestOutputList (
2818 [["mkdir_p"; "/a/b/c"];
2819 ["touch"; "/a/b/c/d"];
2820 ["touch"; "/a/b/c/e"];
2821 ["glob_expand"; "/a/*/x/*"]], [])],
2822 "expand a wildcard path",
2824 This command searches for all the pathnames matching
2825 C<pattern> according to the wildcard expansion rules
2828 If no paths match, then this returns an empty list
2829 (note: not an error).
2831 It is just a wrapper around the C L<glob(3)> function
2832 with flags C<GLOB_MARK|GLOB_BRACE>.
2833 See that manual page for more details.");
2835 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2836 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2837 [["scrub_device"; "/dev/sdc"]])],
2838 "scrub (securely wipe) a device",
2840 This command writes patterns over C<device> to make data retrieval
2843 It is an interface to the L<scrub(1)> program. See that
2844 manual page for more details.");
2846 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2847 [InitBasicFS, Always, TestRun (
2848 [["write"; "/file"; "content"];
2849 ["scrub_file"; "/file"]])],
2850 "scrub (securely wipe) a file",
2852 This command writes patterns over a file to make data retrieval
2855 The file is I<removed> after scrubbing.
2857 It is an interface to the L<scrub(1)> program. See that
2858 manual page for more details.");
2860 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2861 [], (* XXX needs testing *)
2862 "scrub (securely wipe) free space",
2864 This command creates the directory C<dir> and then fills it
2865 with files until the filesystem is full, and scrubs the files
2866 as for C<guestfs_scrub_file>, and deletes them.
2867 The intention is to scrub any free space on the partition
2870 It is an interface to the L<scrub(1)> program. See that
2871 manual page for more details.");
2873 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2874 [InitBasicFS, Always, TestRun (
2876 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2877 "create a temporary directory",
2879 This command creates a temporary directory. The
2880 C<template> parameter should be a full pathname for the
2881 temporary directory name with the final six characters being
2884 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2885 the second one being suitable for Windows filesystems.
2887 The name of the temporary directory that was created
2890 The temporary directory is created with mode 0700
2891 and is owned by root.
2893 The caller is responsible for deleting the temporary
2894 directory and its contents after use.
2896 See also: L<mkdtemp(3)>");
2898 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2899 [InitISOFS, Always, TestOutputInt (
2900 [["wc_l"; "/10klines"]], 10000);
2901 (* Test for RHBZ#579608, absolute symbolic links. *)
2902 InitISOFS, Always, TestOutputInt (
2903 [["wc_l"; "/abssymlink"]], 10000)],
2904 "count lines in a file",
2906 This command counts the lines in a file, using the
2907 C<wc -l> external command.");
2909 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2910 [InitISOFS, Always, TestOutputInt (
2911 [["wc_w"; "/10klines"]], 10000)],
2912 "count words in a file",
2914 This command counts the words in a file, using the
2915 C<wc -w> external command.");
2917 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2918 [InitISOFS, Always, TestOutputInt (
2919 [["wc_c"; "/100kallspaces"]], 102400)],
2920 "count characters in a file",
2922 This command counts the characters in a file, using the
2923 C<wc -c> external command.");
2925 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2926 [InitISOFS, Always, TestOutputList (
2927 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2928 (* Test for RHBZ#579608, absolute symbolic links. *)
2929 InitISOFS, Always, TestOutputList (
2930 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2931 "return first 10 lines of a file",
2933 This command returns up to the first 10 lines of a file as
2934 a list of strings.");
2936 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2937 [InitISOFS, Always, TestOutputList (
2938 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2939 InitISOFS, Always, TestOutputList (
2940 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2941 InitISOFS, Always, TestOutputList (
2942 [["head_n"; "0"; "/10klines"]], [])],
2943 "return first N lines of a file",
2945 If the parameter C<nrlines> is a positive number, this returns the first
2946 C<nrlines> lines of the file C<path>.
2948 If the parameter C<nrlines> is a negative number, this returns lines
2949 from the file C<path>, excluding the last C<nrlines> lines.
2951 If the parameter C<nrlines> is zero, this returns an empty list.");
2953 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2954 [InitISOFS, Always, TestOutputList (
2955 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2956 "return last 10 lines of a file",
2958 This command returns up to the last 10 lines of a file as
2959 a list of strings.");
2961 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2962 [InitISOFS, Always, TestOutputList (
2963 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2964 InitISOFS, Always, TestOutputList (
2965 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2966 InitISOFS, Always, TestOutputList (
2967 [["tail_n"; "0"; "/10klines"]], [])],
2968 "return last N lines of a file",
2970 If the parameter C<nrlines> is a positive number, this returns the last
2971 C<nrlines> lines of the file C<path>.
2973 If the parameter C<nrlines> is a negative number, this returns lines
2974 from the file C<path>, starting with the C<-nrlines>th line.
2976 If the parameter C<nrlines> is zero, this returns an empty list.");
2978 ("df", (RString "output", []), 125, [],
2979 [], (* XXX Tricky to test because it depends on the exact format
2980 * of the 'df' command and other imponderables.
2982 "report file system disk space usage",
2984 This command runs the C<df> command to report disk space used.
2986 This command is mostly useful for interactive sessions. It
2987 is I<not> intended that you try to parse the output string.
2988 Use C<statvfs> from programs.");
2990 ("df_h", (RString "output", []), 126, [],
2991 [], (* XXX Tricky to test because it depends on the exact format
2992 * of the 'df' command and other imponderables.
2994 "report file system disk space usage (human readable)",
2996 This command runs the C<df -h> command to report disk space used
2997 in human-readable format.
2999 This command is mostly useful for interactive sessions. It
3000 is I<not> intended that you try to parse the output string.
3001 Use C<statvfs> from programs.");
3003 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
3004 [InitISOFS, Always, TestOutputInt (
3005 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3006 "estimate file space usage",
3008 This command runs the C<du -s> command to estimate file space
3011 C<path> can be a file or a directory. If C<path> is a directory
3012 then the estimate includes the contents of the directory and all
3013 subdirectories (recursively).
3015 The result is the estimated size in I<kilobytes>
3016 (ie. units of 1024 bytes).");
3018 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
3019 [InitISOFS, Always, TestOutputList (
3020 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3021 "list files in an initrd",
3023 This command lists out files contained in an initrd.
3025 The files are listed without any initial C</> character. The
3026 files are listed in the order they appear (not necessarily
3027 alphabetical). Directory names are listed as separate items.
3029 Old Linux kernels (2.4 and earlier) used a compressed ext2
3030 filesystem as initrd. We I<only> support the newer initramfs
3031 format (compressed cpio files).");
3033 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
3035 "mount a file using the loop device",
3037 This command lets you mount C<file> (a filesystem image
3038 in a file) on a mount point. It is entirely equivalent to
3039 the command C<mount -o loop file mountpoint>.");
3041 ("mkswap", (RErr, [Device "device"]), 130, [],
3042 [InitEmpty, Always, TestRun (
3043 [["part_disk"; "/dev/sda"; "mbr"];
3044 ["mkswap"; "/dev/sda1"]])],
3045 "create a swap partition",
3047 Create a swap partition on C<device>.");
3049 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3050 [InitEmpty, Always, TestRun (
3051 [["part_disk"; "/dev/sda"; "mbr"];
3052 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3053 "create a swap partition with a label",
3055 Create a swap partition on C<device> with label C<label>.
3057 Note that you cannot attach a swap label to a block device
3058 (eg. C</dev/sda>), just to a partition. This appears to be
3059 a limitation of the kernel or swap tools.");
3061 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3062 (let uuid = uuidgen () in
3063 [InitEmpty, Always, TestRun (
3064 [["part_disk"; "/dev/sda"; "mbr"];
3065 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3066 "create a swap partition with an explicit UUID",
3068 Create a swap partition on C<device> with UUID C<uuid>.");
3070 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3071 [InitBasicFS, Always, TestOutputStruct (
3072 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3073 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3074 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3075 InitBasicFS, Always, TestOutputStruct (
3076 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3077 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3078 "make block, character or FIFO devices",
3080 This call creates block or character special devices, or
3081 named pipes (FIFOs).
3083 The C<mode> parameter should be the mode, using the standard
3084 constants. C<devmajor> and C<devminor> are the
3085 device major and minor numbers, only used when creating block
3086 and character special devices.
3088 Note that, just like L<mknod(2)>, the mode must be bitwise
3089 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3090 just creates a regular file). These constants are
3091 available in the standard Linux header files, or you can use
3092 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3093 which are wrappers around this command which bitwise OR
3094 in the appropriate constant for you.
3096 The mode actually set is affected by the umask.");
3098 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3099 [InitBasicFS, Always, TestOutputStruct (
3100 [["mkfifo"; "0o777"; "/node"];
3101 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3102 "make FIFO (named pipe)",
3104 This call creates a FIFO (named pipe) called C<path> with
3105 mode C<mode>. It is just a convenient wrapper around
3108 The mode actually set is affected by the umask.");
3110 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3111 [InitBasicFS, Always, TestOutputStruct (
3112 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3113 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3114 "make block device node",
3116 This call creates a block device node called C<path> with
3117 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3118 It is just a convenient wrapper around C<guestfs_mknod>.
3120 The mode actually set is affected by the umask.");
3122 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3123 [InitBasicFS, Always, TestOutputStruct (
3124 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3125 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3126 "make char device node",
3128 This call creates a char device node called C<path> with
3129 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3130 It is just a convenient wrapper around C<guestfs_mknod>.
3132 The mode actually set is affected by the umask.");
3134 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3135 [InitEmpty, Always, TestOutputInt (
3136 [["umask"; "0o22"]], 0o22)],
3137 "set file mode creation mask (umask)",
3139 This function sets the mask used for creating new files and
3140 device nodes to C<mask & 0777>.
3142 Typical umask values would be C<022> which creates new files
3143 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3144 C<002> which creates new files with permissions like
3145 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3147 The default umask is C<022>. This is important because it
3148 means that directories and device nodes will be created with
3149 C<0644> or C<0755> mode even if you specify C<0777>.
3151 See also C<guestfs_get_umask>,
3152 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3154 This call returns the previous umask.");
3156 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3158 "read directories entries",
3160 This returns the list of directory entries in directory C<dir>.
3162 All entries in the directory are returned, including C<.> and
3163 C<..>. The entries are I<not> sorted, but returned in the same
3164 order as the underlying filesystem.
3166 Also this call returns basic file type information about each
3167 file. The C<ftyp> field will contain one of the following characters:
3205 The L<readdir(3)> call returned a C<d_type> field with an
3210 This function is primarily intended for use by programs. To
3211 get a simple list of names, use C<guestfs_ls>. To get a printable
3212 directory for human consumption, use C<guestfs_ll>.");
3214 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3216 "create partitions on a block device",
3218 This is a simplified interface to the C<guestfs_sfdisk>
3219 command, where partition sizes are specified in megabytes
3220 only (rounded to the nearest cylinder) and you don't need
3221 to specify the cyls, heads and sectors parameters which
3222 were rarely if ever used anyway.
3224 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3225 and C<guestfs_part_disk>");
3227 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3229 "determine file type inside a compressed file",
3231 This command runs C<file> after first decompressing C<path>
3234 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3236 Since 1.0.63, use C<guestfs_file> instead which can now
3237 process compressed files.");
3239 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3241 "list extended attributes of a file or directory",
3243 This call lists the extended attributes of the file or directory
3246 At the system call level, this is a combination of the
3247 L<listxattr(2)> and L<getxattr(2)> calls.
3249 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3251 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3253 "list extended attributes of a file or directory",
3255 This is the same as C<guestfs_getxattrs>, but if C<path>
3256 is a symbolic link, then it returns the extended attributes
3257 of the link itself.");
3259 ("setxattr", (RErr, [String "xattr";
3260 String "val"; Int "vallen"; (* will be BufferIn *)
3261 Pathname "path"]), 143, [Optional "linuxxattrs"],
3263 "set extended attribute of a file or directory",
3265 This call sets the extended attribute named C<xattr>
3266 of the file C<path> to the value C<val> (of length C<vallen>).
3267 The value is arbitrary 8 bit data.
3269 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3271 ("lsetxattr", (RErr, [String "xattr";
3272 String "val"; Int "vallen"; (* will be BufferIn *)
3273 Pathname "path"]), 144, [Optional "linuxxattrs"],
3275 "set extended attribute of a file or directory",
3277 This is the same as C<guestfs_setxattr>, but if C<path>
3278 is a symbolic link, then it sets an extended attribute
3279 of the link itself.");
3281 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3283 "remove extended attribute of a file or directory",
3285 This call removes the extended attribute named C<xattr>
3286 of the file C<path>.
3288 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3290 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3292 "remove extended attribute of a file or directory",
3294 This is the same as C<guestfs_removexattr>, but if C<path>
3295 is a symbolic link, then it removes an extended attribute
3296 of the link itself.");
3298 ("mountpoints", (RHashtable "mps", []), 147, [],
3302 This call is similar to C<guestfs_mounts>. That call returns
3303 a list of devices. This one returns a hash table (map) of
3304 device name to directory where the device is mounted.");
3306 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3307 (* This is a special case: while you would expect a parameter
3308 * of type "Pathname", that doesn't work, because it implies
3309 * NEED_ROOT in the generated calling code in stubs.c, and
3310 * this function cannot use NEED_ROOT.
3313 "create a mountpoint",
3315 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3316 specialized calls that can be used to create extra mountpoints
3317 before mounting the first filesystem.
3319 These calls are I<only> necessary in some very limited circumstances,
3320 mainly the case where you want to mount a mix of unrelated and/or
3321 read-only filesystems together.
3323 For example, live CDs often contain a \"Russian doll\" nest of
3324 filesystems, an ISO outer layer, with a squashfs image inside, with
3325 an ext2/3 image inside that. You can unpack this as follows
3328 add-ro Fedora-11-i686-Live.iso
3331 mkmountpoint /squash
3334 mount-loop /cd/LiveOS/squashfs.img /squash
3335 mount-loop /squash/LiveOS/ext3fs.img /ext3
3337 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3339 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3341 "remove a mountpoint",
3343 This calls removes a mountpoint that was previously created
3344 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3345 for full details.");
3347 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3348 [InitISOFS, Always, TestOutputBuffer (
3349 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3350 (* Test various near large, large and too large files (RHBZ#589039). *)
3351 InitBasicFS, Always, TestLastFail (
3353 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3354 ["read_file"; "/a"]]);
3355 InitBasicFS, Always, TestLastFail (
3357 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3358 ["read_file"; "/a"]]);
3359 InitBasicFS, Always, TestLastFail (
3361 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3362 ["read_file"; "/a"]])],
3365 This calls returns the contents of the file C<path> as a
3368 Unlike C<guestfs_cat>, this function can correctly
3369 handle files that contain embedded ASCII NUL characters.
3370 However unlike C<guestfs_download>, this function is limited
3371 in the total size of file that can be handled.");
3373 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3374 [InitISOFS, Always, TestOutputList (
3375 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3376 InitISOFS, Always, TestOutputList (
3377 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3378 (* Test for RHBZ#579608, absolute symbolic links. *)
3379 InitISOFS, Always, TestOutputList (
3380 [["grep"; "nomatch"; "/abssymlink"]], [])],
3381 "return lines matching a pattern",
3383 This calls the external C<grep> program and returns the
3386 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3387 [InitISOFS, Always, TestOutputList (
3388 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3389 "return lines matching a pattern",
3391 This calls the external C<egrep> program and returns the
3394 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3395 [InitISOFS, Always, TestOutputList (
3396 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3397 "return lines matching a pattern",
3399 This calls the external C<fgrep> program and returns the
3402 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3403 [InitISOFS, Always, TestOutputList (
3404 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3405 "return lines matching a pattern",
3407 This calls the external C<grep -i> program and returns the
3410 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3411 [InitISOFS, Always, TestOutputList (
3412 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3413 "return lines matching a pattern",
3415 This calls the external C<egrep -i> program and returns the
3418 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3419 [InitISOFS, Always, TestOutputList (
3420 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3421 "return lines matching a pattern",
3423 This calls the external C<fgrep -i> program and returns the
3426 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3427 [InitISOFS, Always, TestOutputList (
3428 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3429 "return lines matching a pattern",
3431 This calls the external C<zgrep> program and returns the
3434 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3435 [InitISOFS, Always, TestOutputList (
3436 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3437 "return lines matching a pattern",
3439 This calls the external C<zegrep> program and returns the
3442 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3443 [InitISOFS, Always, TestOutputList (
3444 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3445 "return lines matching a pattern",
3447 This calls the external C<zfgrep> program and returns the
3450 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3451 [InitISOFS, Always, TestOutputList (
3452 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3453 "return lines matching a pattern",
3455 This calls the external C<zgrep -i> program and returns the
3458 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3459 [InitISOFS, Always, TestOutputList (
3460 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3461 "return lines matching a pattern",
3463 This calls the external C<zegrep -i> program and returns the
3466 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3467 [InitISOFS, Always, TestOutputList (
3468 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3469 "return lines matching a pattern",
3471 This calls the external C<zfgrep -i> program and returns the
3474 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3475 [InitISOFS, Always, TestOutput (
3476 [["realpath"; "/../directory"]], "/directory")],
3477 "canonicalized absolute pathname",
3479 Return the canonicalized absolute pathname of C<path>. The
3480 returned path has no C<.>, C<..> or symbolic link path elements.");
3482 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3483 [InitBasicFS, Always, TestOutputStruct (
3486 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3487 "create a hard link",
3489 This command creates a hard link using the C<ln> command.");
3491 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3492 [InitBasicFS, Always, TestOutputStruct (
3495 ["ln_f"; "/a"; "/b"];
3496 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3497 "create a hard link",
3499 This command creates a hard link using the C<ln -f> command.
3500 The C<-f> option removes the link (C<linkname>) if it exists already.");
3502 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3503 [InitBasicFS, Always, TestOutputStruct (
3505 ["ln_s"; "a"; "/b"];
3506 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3507 "create a symbolic link",
3509 This command creates a symbolic link using the C<ln -s> command.");
3511 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3512 [InitBasicFS, Always, TestOutput (
3513 [["mkdir_p"; "/a/b"];
3514 ["touch"; "/a/b/c"];
3515 ["ln_sf"; "../d"; "/a/b/c"];
3516 ["readlink"; "/a/b/c"]], "../d")],
3517 "create a symbolic link",
3519 This command creates a symbolic link using the C<ln -sf> command,
3520 The C<-f> option removes the link (C<linkname>) if it exists already.");
3522 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3523 [] (* XXX tested above *),
3524 "read the target of a symbolic link",
3526 This command reads the target of a symbolic link.");
3528 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3529 [InitBasicFS, Always, TestOutputStruct (
3530 [["fallocate"; "/a"; "1000000"];
3531 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3532 "preallocate a file in the guest filesystem",
3534 This command preallocates a file (containing zero bytes) named
3535 C<path> of size C<len> bytes. If the file exists already, it
3538 Do not confuse this with the guestfish-specific
3539 C<alloc> command which allocates a file in the host and
3540 attaches it as a device.");
3542 ("swapon_device", (RErr, [Device "device"]), 170, [],
3543 [InitPartition, Always, TestRun (
3544 [["mkswap"; "/dev/sda1"];
3545 ["swapon_device"; "/dev/sda1"];
3546 ["swapoff_device"; "/dev/sda1"]])],
3547 "enable swap on device",
3549 This command enables the libguestfs appliance to use the
3550 swap device or partition named C<device>. The increased
3551 memory is made available for all commands, for example
3552 those run using C<guestfs_command> or C<guestfs_sh>.
3554 Note that you should not swap to existing guest swap
3555 partitions unless you know what you are doing. They may
3556 contain hibernation information, or other information that
3557 the guest doesn't want you to trash. You also risk leaking
3558 information about the host to the guest this way. Instead,
3559 attach a new host device to the guest and swap on that.");
3561 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3562 [], (* XXX tested by swapon_device *)
3563 "disable swap on device",
3565 This command disables the libguestfs appliance swap
3566 device or partition named C<device>.
3567 See C<guestfs_swapon_device>.");
3569 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3570 [InitBasicFS, Always, TestRun (
3571 [["fallocate"; "/swap"; "8388608"];
3572 ["mkswap_file"; "/swap"];
3573 ["swapon_file"; "/swap"];
3574 ["swapoff_file"; "/swap"]])],
3575 "enable swap on file",
3577 This command enables swap to a file.
3578 See C<guestfs_swapon_device> for other notes.");
3580 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3581 [], (* XXX tested by swapon_file *)
3582 "disable swap on file",
3584 This command disables the libguestfs appliance swap on file.");
3586 ("swapon_label", (RErr, [String "label"]), 174, [],
3587 [InitEmpty, Always, TestRun (
3588 [["part_disk"; "/dev/sdb"; "mbr"];
3589 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3590 ["swapon_label"; "swapit"];
3591 ["swapoff_label"; "swapit"];
3592 ["zero"; "/dev/sdb"];
3593 ["blockdev_rereadpt"; "/dev/sdb"]])],
3594 "enable swap on labeled swap partition",
3596 This command enables swap to a labeled swap partition.
3597 See C<guestfs_swapon_device> for other notes.");
3599 ("swapoff_label", (RErr, [String "label"]), 175, [],
3600 [], (* XXX tested by swapon_label *)
3601 "disable swap on labeled swap partition",
3603 This command disables the libguestfs appliance swap on
3604 labeled swap partition.");
3606 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3607 (let uuid = uuidgen () in
3608 [InitEmpty, Always, TestRun (
3609 [["mkswap_U"; uuid; "/dev/sdb"];
3610 ["swapon_uuid"; uuid];
3611 ["swapoff_uuid"; uuid]])]),
3612 "enable swap on swap partition by UUID",
3614 This command enables swap to a swap partition with the given UUID.
3615 See C<guestfs_swapon_device> for other notes.");
3617 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3618 [], (* XXX tested by swapon_uuid *)
3619 "disable swap on swap partition by UUID",
3621 This command disables the libguestfs appliance swap partition
3622 with the given UUID.");
3624 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3625 [InitBasicFS, Always, TestRun (
3626 [["fallocate"; "/swap"; "8388608"];
3627 ["mkswap_file"; "/swap"]])],
3628 "create a swap file",
3632 This command just writes a swap file signature to an existing
3633 file. To create the file itself, use something like C<guestfs_fallocate>.");
3635 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3636 [InitISOFS, Always, TestRun (
3637 [["inotify_init"; "0"]])],
3638 "create an inotify handle",
3640 This command creates a new inotify handle.
3641 The inotify subsystem can be used to notify events which happen to
3642 objects in the guest filesystem.
3644 C<maxevents> is the maximum number of events which will be
3645 queued up between calls to C<guestfs_inotify_read> or
3646 C<guestfs_inotify_files>.
3647 If this is passed as C<0>, then the kernel (or previously set)
3648 default is used. For Linux 2.6.29 the default was 16384 events.
3649 Beyond this limit, the kernel throws away events, but records
3650 the fact that it threw them away by setting a flag
3651 C<IN_Q_OVERFLOW> in the returned structure list (see
3652 C<guestfs_inotify_read>).
3654 Before any events are generated, you have to add some
3655 watches to the internal watch list. See:
3656 C<guestfs_inotify_add_watch>,
3657 C<guestfs_inotify_rm_watch> and
3658 C<guestfs_inotify_watch_all>.
3660 Queued up events should be read periodically by calling
3661 C<guestfs_inotify_read>
3662 (or C<guestfs_inotify_files> which is just a helpful
3663 wrapper around C<guestfs_inotify_read>). If you don't
3664 read the events out often enough then you risk the internal
3667 The handle should be closed after use by calling
3668 C<guestfs_inotify_close>. This also removes any
3669 watches automatically.
3671 See also L<inotify(7)> for an overview of the inotify interface
3672 as exposed by the Linux kernel, which is roughly what we expose
3673 via libguestfs. Note that there is one global inotify handle
3674 per libguestfs instance.");
3676 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3677 [InitBasicFS, Always, TestOutputList (
3678 [["inotify_init"; "0"];
3679 ["inotify_add_watch"; "/"; "1073741823"];
3682 ["inotify_files"]], ["a"; "b"])],
3683 "add an inotify watch",
3685 Watch C<path> for the events listed in C<mask>.
3687 Note that if C<path> is a directory then events within that
3688 directory are watched, but this does I<not> happen recursively
3689 (in subdirectories).
3691 Note for non-C or non-Linux callers: the inotify events are
3692 defined by the Linux kernel ABI and are listed in
3693 C</usr/include/sys/inotify.h>.");
3695 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3697 "remove an inotify watch",
3699 Remove a previously defined inotify watch.
3700 See C<guestfs_inotify_add_watch>.");
3702 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3704 "return list of inotify events",
3706 Return the complete queue of events that have happened
3707 since the previous read call.
3709 If no events have happened, this returns an empty list.
3711 I<Note>: In order to make sure that all events have been
3712 read, you must call this function repeatedly until it
3713 returns an empty list. The reason is that the call will
3714 read events up to the maximum appliance-to-host message
3715 size and leave remaining events in the queue.");
3717 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3719 "return list of watched files that had events",
3721 This function is a helpful wrapper around C<guestfs_inotify_read>
3722 which just returns a list of pathnames of objects that were
3723 touched. The returned pathnames are sorted and deduplicated.");
3725 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3727 "close the inotify handle",
3729 This closes the inotify handle which was previously
3730 opened by inotify_init. It removes all watches, throws
3731 away any pending events, and deallocates all resources.");
3733 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3735 "set SELinux security context",
3737 This sets the SELinux security context of the daemon
3738 to the string C<context>.
3740 See the documentation about SELINUX in L<guestfs(3)>.");
3742 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3744 "get SELinux security context",
3746 This gets the SELinux security context of the daemon.
3748 See the documentation about SELINUX in L<guestfs(3)>,
3749 and C<guestfs_setcon>");
3751 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3752 [InitEmpty, Always, TestOutput (
3753 [["part_disk"; "/dev/sda"; "mbr"];
3754 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3755 ["mount_options"; ""; "/dev/sda1"; "/"];
3756 ["write"; "/new"; "new file contents"];
3757 ["cat"; "/new"]], "new file contents");
3758 InitEmpty, Always, TestRun (
3759 [["part_disk"; "/dev/sda"; "mbr"];
3760 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3761 InitEmpty, Always, TestLastFail (
3762 [["part_disk"; "/dev/sda"; "mbr"];
3763 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3764 InitEmpty, Always, TestLastFail (
3765 [["part_disk"; "/dev/sda"; "mbr"];
3766 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3767 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3768 [["part_disk"; "/dev/sda"; "mbr"];
3769 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3770 "make a filesystem with block size",
3772 This call is similar to C<guestfs_mkfs>, but it allows you to
3773 control the block size of the resulting filesystem. Supported
3774 block sizes depend on the filesystem type, but typically they
3775 are C<1024>, C<2048> or C<4096> only.
3777 For VFAT and NTFS the C<blocksize> parameter is treated as
3778 the requested cluster size.");
3780 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3781 [InitEmpty, Always, TestOutput (
3782 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3783 ["mke2journal"; "4096"; "/dev/sda1"];
3784 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3785 ["mount_options"; ""; "/dev/sda2"; "/"];
3786 ["write"; "/new"; "new file contents"];
3787 ["cat"; "/new"]], "new file contents")],
3788 "make ext2/3/4 external journal",
3790 This creates an ext2 external journal on C<device>. It is equivalent
3793 mke2fs -O journal_dev -b blocksize device");
3795 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3796 [InitEmpty, Always, TestOutput (
3797 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3798 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3799 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3800 ["mount_options"; ""; "/dev/sda2"; "/"];
3801 ["write"; "/new"; "new file contents"];
3802 ["cat"; "/new"]], "new file contents")],
3803 "make ext2/3/4 external journal with label",
3805 This creates an ext2 external journal on C<device> with label C<label>.");
3807 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3808 (let uuid = uuidgen () in
3809 [InitEmpty, Always, TestOutput (
3810 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3811 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3812 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3813 ["mount_options"; ""; "/dev/sda2"; "/"];
3814 ["write"; "/new"; "new file contents"];
3815 ["cat"; "/new"]], "new file contents")]),
3816 "make ext2/3/4 external journal with UUID",
3818 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3820 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3822 "make ext2/3/4 filesystem with external journal",
3824 This creates an ext2/3/4 filesystem on C<device> with
3825 an external journal on C<journal>. It is equivalent
3828 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3830 See also C<guestfs_mke2journal>.");
3832 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3834 "make ext2/3/4 filesystem with external journal",
3836 This creates an ext2/3/4 filesystem on C<device> with
3837 an external journal on the journal labeled C<label>.
3839 See also C<guestfs_mke2journal_L>.");
3841 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3843 "make ext2/3/4 filesystem with external journal",
3845 This creates an ext2/3/4 filesystem on C<device> with
3846 an external journal on the journal with UUID C<uuid>.
3848 See also C<guestfs_mke2journal_U>.");
3850 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3851 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3852 "load a kernel module",
3854 This loads a kernel module in the appliance.
3856 The kernel module must have been whitelisted when libguestfs
3857 was built (see C<appliance/kmod.whitelist.in> in the source).");
3859 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3860 [InitNone, Always, TestOutput (
3861 [["echo_daemon"; "This is a test"]], "This is a test"
3863 "echo arguments back to the client",
3865 This command concatenates the list of C<words> passed with single spaces
3866 between them and returns the resulting string.
3868 You can use this command to test the connection through to the daemon.
3870 See also C<guestfs_ping_daemon>.");
3872 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3873 [], (* There is a regression test for this. *)
3874 "find all files and directories, returning NUL-separated list",
3876 This command lists out all files and directories, recursively,
3877 starting at C<directory>, placing the resulting list in the
3878 external file called C<files>.
3880 This command works the same way as C<guestfs_find> with the
3881 following exceptions:
3887 The resulting list is written to an external file.
3891 Items (filenames) in the result are separated
3892 by C<\\0> characters. See L<find(1)> option I<-print0>.
3896 This command is not limited in the number of names that it
3901 The result list is not sorted.
3905 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3906 [InitISOFS, Always, TestOutput (
3907 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3908 InitISOFS, Always, TestOutput (
3909 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3910 InitISOFS, Always, TestOutput (
3911 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3912 InitISOFS, Always, TestLastFail (
3913 [["case_sensitive_path"; "/Known-1/"]]);
3914 InitBasicFS, Always, TestOutput (
3916 ["mkdir"; "/a/bbb"];
3917 ["touch"; "/a/bbb/c"];
3918 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3919 InitBasicFS, Always, TestOutput (
3921 ["mkdir"; "/a/bbb"];
3922 ["touch"; "/a/bbb/c"];
3923 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3924 InitBasicFS, Always, TestLastFail (
3926 ["mkdir"; "/a/bbb"];
3927 ["touch"; "/a/bbb/c"];
3928 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3929 "return true path on case-insensitive filesystem",
3931 This can be used to resolve case insensitive paths on
3932 a filesystem which is case sensitive. The use case is
3933 to resolve paths which you have read from Windows configuration
3934 files or the Windows Registry, to the true path.
3936 The command handles a peculiarity of the Linux ntfs-3g
3937 filesystem driver (and probably others), which is that although
3938 the underlying filesystem is case-insensitive, the driver
3939 exports the filesystem to Linux as case-sensitive.
3941 One consequence of this is that special directories such
3942 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3943 (or other things) depending on the precise details of how
3944 they were created. In Windows itself this would not be
3947 Bug or feature? You decide:
3948 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3950 This function resolves the true case of each element in the
3951 path and returns the case-sensitive path.
3953 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3954 might return C<\"/WINDOWS/system32\"> (the exact return value
3955 would depend on details of how the directories were originally
3956 created under Windows).
3959 This function does not handle drive names, backslashes etc.
3961 See also C<guestfs_realpath>.");
3963 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3964 [InitBasicFS, Always, TestOutput (
3965 [["vfs_type"; "/dev/sda1"]], "ext2")],
3966 "get the Linux VFS type corresponding to a mounted device",
3968 This command gets the filesystem type corresponding to
3969 the filesystem on C<device>.
3971 For most filesystems, the result is the name of the Linux
3972 VFS module which would be used to mount this filesystem
3973 if you mounted it without specifying the filesystem type.
3974 For example a string such as C<ext3> or C<ntfs>.");
3976 ("truncate", (RErr, [Pathname "path"]), 199, [],
3977 [InitBasicFS, Always, TestOutputStruct (
3978 [["write"; "/test"; "some stuff so size is not zero"];
3979 ["truncate"; "/test"];
3980 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3981 "truncate a file to zero size",
3983 This command truncates C<path> to a zero-length file. The
3984 file must exist already.");
3986 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3987 [InitBasicFS, Always, TestOutputStruct (
3988 [["touch"; "/test"];
3989 ["truncate_size"; "/test"; "1000"];
3990 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3991 "truncate a file to a particular size",
3993 This command truncates C<path> to size C<size> bytes. The file
3996 If the current file size is less than C<size> then
3997 the file is extended to the required size with zero bytes.
3998 This creates a sparse file (ie. disk blocks are not allocated
3999 for the file until you write to it). To create a non-sparse
4000 file of zeroes, use C<guestfs_fallocate64> instead.");
4002 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
4003 [InitBasicFS, Always, TestOutputStruct (
4004 [["touch"; "/test"];
4005 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4006 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4007 "set timestamp of a file with nanosecond precision",
4009 This command sets the timestamps of a file with nanosecond
4012 C<atsecs, atnsecs> are the last access time (atime) in secs and
4013 nanoseconds from the epoch.
4015 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4016 secs and nanoseconds from the epoch.
4018 If the C<*nsecs> field contains the special value C<-1> then
4019 the corresponding timestamp is set to the current time. (The
4020 C<*secs> field is ignored in this case).
4022 If the C<*nsecs> field contains the special value C<-2> then
4023 the corresponding timestamp is left unchanged. (The
4024 C<*secs> field is ignored in this case).");
4026 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
4027 [InitBasicFS, Always, TestOutputStruct (
4028 [["mkdir_mode"; "/test"; "0o111"];
4029 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4030 "create a directory with a particular mode",
4032 This command creates a directory, setting the initial permissions
4033 of the directory to C<mode>.
4035 For common Linux filesystems, the actual mode which is set will
4036 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4037 interpret the mode in other ways.
4039 See also C<guestfs_mkdir>, C<guestfs_umask>");
4041 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
4043 "change file owner and group",
4045 Change the file owner to C<owner> and group to C<group>.
4046 This is like C<guestfs_chown> but if C<path> is a symlink then
4047 the link itself is changed, not the target.
4049 Only numeric uid and gid are supported. If you want to use
4050 names, you will need to locate and parse the password file
4051 yourself (Augeas support makes this relatively easy).");
4053 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
4055 "lstat on multiple files",
4057 This call allows you to perform the C<guestfs_lstat> operation
4058 on multiple files, where all files are in the directory C<path>.
4059 C<names> is the list of files from this directory.
4061 On return you get a list of stat structs, with a one-to-one
4062 correspondence to the C<names> list. If any name did not exist
4063 or could not be lstat'd, then the C<ino> field of that structure
4066 This call is intended for programs that want to efficiently
4067 list a directory contents without making many round-trips.
4068 See also C<guestfs_lxattrlist> for a similarly efficient call
4069 for getting extended attributes. Very long directory listings
4070 might cause the protocol message size to be exceeded, causing
4071 this call to fail. The caller must split up such requests
4072 into smaller groups of names.");
4074 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4076 "lgetxattr on multiple files",
4078 This call allows you to get the extended attributes
4079 of multiple files, where all files are in the directory C<path>.
4080 C<names> is the list of files from this directory.
4082 On return you get a flat list of xattr structs which must be
4083 interpreted sequentially. The first xattr struct always has a zero-length
4084 C<attrname>. C<attrval> in this struct is zero-length
4085 to indicate there was an error doing C<lgetxattr> for this
4086 file, I<or> is a C string which is a decimal number
4087 (the number of following attributes for this file, which could
4088 be C<\"0\">). Then after the first xattr struct are the
4089 zero or more attributes for the first named file.
4090 This repeats for the second and subsequent files.
4092 This call is intended for programs that want to efficiently
4093 list a directory contents without making many round-trips.
4094 See also C<guestfs_lstatlist> for a similarly efficient call
4095 for getting standard stats. Very long directory listings
4096 might cause the protocol message size to be exceeded, causing
4097 this call to fail. The caller must split up such requests
4098 into smaller groups of names.");
4100 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4102 "readlink on multiple files",
4104 This call allows you to do a C<readlink> operation
4105 on multiple files, where all files are in the directory C<path>.
4106 C<names> is the list of files from this directory.
4108 On return you get a list of strings, with a one-to-one
4109 correspondence to the C<names> list. Each string is the
4110 value of the symbolic link.
4112 If the C<readlink(2)> operation fails on any name, then
4113 the corresponding result string is the empty string C<\"\">.
4114 However the whole operation is completed even if there
4115 were C<readlink(2)> errors, and so you can call this
4116 function with names where you don't know if they are
4117 symbolic links already (albeit slightly less efficient).
4119 This call is intended for programs that want to efficiently
4120 list a directory contents without making many round-trips.
4121 Very long directory listings might cause the protocol
4122 message size to be exceeded, causing
4123 this call to fail. The caller must split up such requests
4124 into smaller groups of names.");
4126 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4127 [InitISOFS, Always, TestOutputBuffer (
4128 [["pread"; "/known-4"; "1"; "3"]], "\n");
4129 InitISOFS, Always, TestOutputBuffer (
4130 [["pread"; "/empty"; "0"; "100"]], "")],
4131 "read part of a file",
4133 This command lets you read part of a file. It reads C<count>
4134 bytes of the file, starting at C<offset>, from file C<path>.
4136 This may read fewer bytes than requested. For further details
4137 see the L<pread(2)> system call.
4139 See also C<guestfs_pwrite>.");
4141 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4142 [InitEmpty, Always, TestRun (
4143 [["part_init"; "/dev/sda"; "gpt"]])],
4144 "create an empty partition table",
4146 This creates an empty partition table on C<device> of one of the
4147 partition types listed below. Usually C<parttype> should be
4148 either C<msdos> or C<gpt> (for large disks).
4150 Initially there are no partitions. Following this, you should
4151 call C<guestfs_part_add> for each partition required.
4153 Possible values for C<parttype> are:
4157 =item B<efi> | B<gpt>
4159 Intel EFI / GPT partition table.
4161 This is recommended for >= 2 TB partitions that will be accessed
4162 from Linux and Intel-based Mac OS X. It also has limited backwards
4163 compatibility with the C<mbr> format.
4165 =item B<mbr> | B<msdos>
4167 The standard PC \"Master Boot Record\" (MBR) format used
4168 by MS-DOS and Windows. This partition type will B<only> work
4169 for device sizes up to 2 TB. For large disks we recommend
4174 Other partition table types that may work but are not
4183 =item B<amiga> | B<rdb>
4185 Amiga \"Rigid Disk Block\" format.
4193 DASD, used on IBM mainframes.
4201 Old Mac partition format. Modern Macs use C<gpt>.
4205 NEC PC-98 format, common in Japan apparently.
4213 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4214 [InitEmpty, Always, TestRun (
4215 [["part_init"; "/dev/sda"; "mbr"];
4216 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4217 InitEmpty, Always, TestRun (
4218 [["part_init"; "/dev/sda"; "gpt"];
4219 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4220 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4221 InitEmpty, Always, TestRun (
4222 [["part_init"; "/dev/sda"; "mbr"];
4223 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4224 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4225 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4226 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4227 "add a partition to the device",
4229 This command adds a partition to C<device>. If there is no partition
4230 table on the device, call C<guestfs_part_init> first.
4232 The C<prlogex> parameter is the type of partition. Normally you
4233 should pass C<p> or C<primary> here, but MBR partition tables also
4234 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4237 C<startsect> and C<endsect> are the start and end of the partition
4238 in I<sectors>. C<endsect> may be negative, which means it counts
4239 backwards from the end of the disk (C<-1> is the last sector).
4241 Creating a partition which covers the whole disk is not so easy.
4242 Use C<guestfs_part_disk> to do that.");
4244 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4245 [InitEmpty, Always, TestRun (
4246 [["part_disk"; "/dev/sda"; "mbr"]]);
4247 InitEmpty, Always, TestRun (
4248 [["part_disk"; "/dev/sda"; "gpt"]])],
4249 "partition whole disk with a single primary partition",
4251 This command is simply a combination of C<guestfs_part_init>
4252 followed by C<guestfs_part_add> to create a single primary partition
4253 covering the whole disk.
4255 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4256 but other possible values are described in C<guestfs_part_init>.");
4258 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4259 [InitEmpty, Always, TestRun (
4260 [["part_disk"; "/dev/sda"; "mbr"];
4261 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4262 "make a partition bootable",
4264 This sets the bootable flag on partition numbered C<partnum> on
4265 device C<device>. Note that partitions are numbered from 1.
4267 The bootable flag is used by some operating systems (notably
4268 Windows) to determine which partition to boot from. It is by
4269 no means universally recognized.");
4271 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4272 [InitEmpty, Always, TestRun (
4273 [["part_disk"; "/dev/sda"; "gpt"];
4274 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4275 "set partition name",
4277 This sets the partition name on partition numbered C<partnum> on
4278 device C<device>. Note that partitions are numbered from 1.
4280 The partition name can only be set on certain types of partition
4281 table. This works on C<gpt> but not on C<mbr> partitions.");
4283 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4284 [], (* XXX Add a regression test for this. *)
4285 "list partitions on a device",
4287 This command parses the partition table on C<device> and
4288 returns the list of partitions found.
4290 The fields in the returned structure are:
4296 Partition number, counting from 1.
4300 Start of the partition I<in bytes>. To get sectors you have to
4301 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4305 End of the partition in bytes.
4309 Size of the partition in bytes.
4313 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4314 [InitEmpty, Always, TestOutput (
4315 [["part_disk"; "/dev/sda"; "gpt"];
4316 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4317 "get the partition table type",
4319 This command examines the partition table on C<device> and
4320 returns the partition table type (format) being used.
4322 Common return values include: C<msdos> (a DOS/Windows style MBR
4323 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4324 values are possible, although unusual. See C<guestfs_part_init>
4327 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4328 [InitBasicFS, Always, TestOutputBuffer (
4329 [["fill"; "0x63"; "10"; "/test"];
4330 ["read_file"; "/test"]], "cccccccccc")],
4331 "fill a file with octets",
4333 This command creates a new file called C<path>. The initial
4334 content of the file is C<len> octets of C<c>, where C<c>
4335 must be a number in the range C<[0..255]>.
4337 To fill a file with zero bytes (sparsely), it is
4338 much more efficient to use C<guestfs_truncate_size>.
4339 To create a file with a pattern of repeating bytes
4340 use C<guestfs_fill_pattern>.");
4342 ("available", (RErr, [StringList "groups"]), 216, [],
4343 [InitNone, Always, TestRun [["available"; ""]]],
4344 "test availability of some parts of the API",
4346 This command is used to check the availability of some
4347 groups of functionality in the appliance, which not all builds of
4348 the libguestfs appliance will be able to provide.
4350 The libguestfs groups, and the functions that those
4351 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4352 You can also fetch this list at runtime by calling
4353 C<guestfs_available_all_groups>.
4355 The argument C<groups> is a list of group names, eg:
4356 C<[\"inotify\", \"augeas\"]> would check for the availability of
4357 the Linux inotify functions and Augeas (configuration file
4360 The command returns no error if I<all> requested groups are available.
4362 It fails with an error if one or more of the requested
4363 groups is unavailable in the appliance.
4365 If an unknown group name is included in the
4366 list of groups then an error is always returned.
4374 You must call C<guestfs_launch> before calling this function.
4376 The reason is because we don't know what groups are
4377 supported by the appliance/daemon until it is running and can
4382 If a group of functions is available, this does not necessarily
4383 mean that they will work. You still have to check for errors
4384 when calling individual API functions even if they are
4389 It is usually the job of distro packagers to build
4390 complete functionality into the libguestfs appliance.
4391 Upstream libguestfs, if built from source with all
4392 requirements satisfied, will support everything.
4396 This call was added in version C<1.0.80>. In previous
4397 versions of libguestfs all you could do would be to speculatively
4398 execute a command to find out if the daemon implemented it.
4399 See also C<guestfs_version>.
4403 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4404 [InitBasicFS, Always, TestOutputBuffer (
4405 [["write"; "/src"; "hello, world"];
4406 ["dd"; "/src"; "/dest"];
4407 ["read_file"; "/dest"]], "hello, world")],
4408 "copy from source to destination using dd",
4410 This command copies from one source device or file C<src>
4411 to another destination device or file C<dest>. Normally you
4412 would use this to copy to or from a device or partition, for
4413 example to duplicate a filesystem.
4415 If the destination is a device, it must be as large or larger
4416 than the source file or device, otherwise the copy will fail.
4417 This command cannot do partial copies (see C<guestfs_copy_size>).");
4419 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4420 [InitBasicFS, Always, TestOutputInt (
4421 [["write"; "/file"; "hello, world"];
4422 ["filesize"; "/file"]], 12)],
4423 "return the size of the file in bytes",
4425 This command returns the size of C<file> in bytes.
4427 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4428 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4429 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4431 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4432 [InitBasicFSonLVM, Always, TestOutputList (
4433 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4434 ["lvs"]], ["/dev/VG/LV2"])],
4435 "rename an LVM logical volume",
4437 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4439 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4440 [InitBasicFSonLVM, Always, TestOutputList (
4442 ["vg_activate"; "false"; "VG"];
4443 ["vgrename"; "VG"; "VG2"];
4444 ["vg_activate"; "true"; "VG2"];
4445 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4446 ["vgs"]], ["VG2"])],
4447 "rename an LVM volume group",
4449 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4451 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4452 [InitISOFS, Always, TestOutputBuffer (
4453 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4454 "list the contents of a single file in an initrd",
4456 This command unpacks the file C<filename> from the initrd file
4457 called C<initrdpath>. The filename must be given I<without> the
4458 initial C</> character.
4460 For example, in guestfish you could use the following command
4461 to examine the boot script (usually called C</init>)
4462 contained in a Linux initrd or initramfs image:
4464 initrd-cat /boot/initrd-<version>.img init
4466 See also C<guestfs_initrd_list>.");
4468 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4470 "get the UUID of a physical volume",
4472 This command returns the UUID of the LVM PV C<device>.");
4474 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4476 "get the UUID of a volume group",
4478 This command returns the UUID of the LVM VG named C<vgname>.");
4480 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4482 "get the UUID of a logical volume",
4484 This command returns the UUID of the LVM LV C<device>.");
4486 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4488 "get the PV UUIDs containing the volume group",
4490 Given a VG called C<vgname>, this returns the UUIDs of all
4491 the physical volumes that this volume group resides on.
4493 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4494 calls to associate physical volumes and volume groups.
4496 See also C<guestfs_vglvuuids>.");
4498 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4500 "get the LV UUIDs of all LVs in the volume group",
4502 Given a VG called C<vgname>, this returns the UUIDs of all
4503 the logical volumes created in this volume group.
4505 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4506 calls to associate logical volumes and volume groups.
4508 See also C<guestfs_vgpvuuids>.");
4510 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4511 [InitBasicFS, Always, TestOutputBuffer (
4512 [["write"; "/src"; "hello, world"];
4513 ["copy_size"; "/src"; "/dest"; "5"];
4514 ["read_file"; "/dest"]], "hello")],
4515 "copy size bytes from source to destination using dd",
4517 This command copies exactly C<size> bytes from one source device
4518 or file C<src> to another destination device or file C<dest>.
4520 Note this will fail if the source is too short or if the destination
4521 is not large enough.");
4523 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4524 [InitBasicFSonLVM, Always, TestRun (
4525 [["zero_device"; "/dev/VG/LV"]])],
4526 "write zeroes to an entire device",
4528 This command writes zeroes over the entire C<device>. Compare
4529 with C<guestfs_zero> which just zeroes the first few blocks of
4532 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [Optional "xz"],
4533 [InitBasicFS, Always, TestOutput (
4534 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4535 ["cat"; "/hello"]], "hello\n")],
4536 "unpack compressed tarball to directory",
4538 This command uploads and unpacks local file C<tarball> (an
4539 I<xz compressed> tar file) into C<directory>.");
4541 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [Optional "xz"],
4543 "pack directory into compressed tarball",
4545 This command packs the contents of C<directory> and downloads
4546 it to local file C<tarball> (as an xz compressed tar archive).");
4548 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4550 "resize an NTFS filesystem",
4552 This command resizes an NTFS filesystem, expanding or
4553 shrinking it to the size of the underlying device.
4554 See also L<ntfsresize(8)>.");
4556 ("vgscan", (RErr, []), 232, [],
4557 [InitEmpty, Always, TestRun (
4559 "rescan for LVM physical volumes, volume groups and logical volumes",
4561 This rescans all block devices and rebuilds the list of LVM
4562 physical volumes, volume groups and logical volumes.");
4564 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4565 [InitEmpty, Always, TestRun (
4566 [["part_init"; "/dev/sda"; "mbr"];
4567 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4568 ["part_del"; "/dev/sda"; "1"]])],
4569 "delete a partition",
4571 This command deletes the partition numbered C<partnum> on C<device>.
4573 Note that in the case of MBR partitioning, deleting an
4574 extended partition also deletes any logical partitions
4577 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4578 [InitEmpty, Always, TestOutputTrue (
4579 [["part_init"; "/dev/sda"; "mbr"];
4580 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4581 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4582 ["part_get_bootable"; "/dev/sda"; "1"]])],
4583 "return true if a partition is bootable",
4585 This command returns true if the partition C<partnum> on
4586 C<device> has the bootable flag set.
4588 See also C<guestfs_part_set_bootable>.");
4590 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4591 [InitEmpty, Always, TestOutputInt (
4592 [["part_init"; "/dev/sda"; "mbr"];
4593 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4594 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4595 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4596 "get the MBR type byte (ID byte) from a partition",
4598 Returns the MBR type byte (also known as the ID byte) from
4599 the numbered partition C<partnum>.
4601 Note that only MBR (old DOS-style) partitions have type bytes.
4602 You will get undefined results for other partition table
4603 types (see C<guestfs_part_get_parttype>).");
4605 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4606 [], (* tested by part_get_mbr_id *)
4607 "set the MBR type byte (ID byte) of a partition",
4609 Sets the MBR type byte (also known as the ID byte) of
4610 the numbered partition C<partnum> to C<idbyte>. Note
4611 that the type bytes quoted in most documentation are
4612 in fact hexadecimal numbers, but usually documented
4613 without any leading \"0x\" which might be confusing.
4615 Note that only MBR (old DOS-style) partitions have type bytes.
4616 You will get undefined results for other partition table
4617 types (see C<guestfs_part_get_parttype>).");
4619 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4620 [InitISOFS, Always, TestOutput (
4621 [["checksum_device"; "md5"; "/dev/sdd"]],
4622 (Digest.to_hex (Digest.file "images/test.iso")))],
4623 "compute MD5, SHAx or CRC checksum of the contents of a device",
4625 This call computes the MD5, SHAx or CRC checksum of the
4626 contents of the device named C<device>. For the types of
4627 checksums supported see the C<guestfs_checksum> command.");
4629 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4630 [InitNone, Always, TestRun (
4631 [["part_disk"; "/dev/sda"; "mbr"];
4632 ["pvcreate"; "/dev/sda1"];
4633 ["vgcreate"; "VG"; "/dev/sda1"];
4634 ["lvcreate"; "LV"; "VG"; "10"];
4635 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4636 "expand an LV to fill free space",
4638 This expands an existing logical volume C<lv> so that it fills
4639 C<pc>% of the remaining free space in the volume group. Commonly
4640 you would call this with pc = 100 which expands the logical volume
4641 as much as possible, using all remaining free space in the volume
4644 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4645 [], (* XXX Augeas code needs tests. *)
4646 "clear Augeas path",
4648 Set the value associated with C<path> to C<NULL>. This
4649 is the same as the L<augtool(1)> C<clear> command.");
4651 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
4652 [InitEmpty, Always, TestOutputInt (
4653 [["get_umask"]], 0o22)],
4654 "get the current umask",
4656 Return the current umask. By default the umask is C<022>
4657 unless it has been set by calling C<guestfs_umask>.");
4659 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
4661 "upload a file to the appliance (internal use only)",
4663 The C<guestfs_debug_upload> command uploads a file to
4664 the libguestfs appliance.
4666 There is no comprehensive help for this command. You have
4667 to look at the file C<daemon/debug.c> in the libguestfs source
4668 to find out what it is for.");
4670 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
4671 [InitBasicFS, Always, TestOutput (
4672 [["base64_in"; "../images/hello.b64"; "/hello"];
4673 ["cat"; "/hello"]], "hello\n")],
4674 "upload base64-encoded data to file",
4676 This command uploads base64-encoded data from C<base64file>
4679 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
4681 "download file and encode as base64",
4683 This command downloads the contents of C<filename>, writing
4684 it out to local file C<base64file> encoded as base64.");
4686 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
4688 "compute MD5, SHAx or CRC checksum of files in a directory",
4690 This command computes the checksums of all regular files in
4691 C<directory> and then emits a list of those checksums to
4692 the local output file C<sumsfile>.
4694 This can be used for verifying the integrity of a virtual
4695 machine. However to be properly secure you should pay
4696 attention to the output of the checksum command (it uses
4697 the ones from GNU coreutils). In particular when the
4698 filename is not printable, coreutils uses a special
4699 backslash syntax. For more information, see the GNU
4700 coreutils info file.");
4702 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
4703 [InitBasicFS, Always, TestOutputBuffer (
4704 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4705 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4706 "fill a file with a repeating pattern of bytes",
4708 This function is like C<guestfs_fill> except that it creates
4709 a new file of length C<len> containing the repeating pattern
4710 of bytes in C<pattern>. The pattern is truncated if necessary
4711 to ensure the length of the file is exactly C<len> bytes.");
4713 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
4714 [InitBasicFS, Always, TestOutput (
4715 [["write"; "/new"; "new file contents"];
4716 ["cat"; "/new"]], "new file contents");
4717 InitBasicFS, Always, TestOutput (
4718 [["write"; "/new"; "\nnew file contents\n"];
4719 ["cat"; "/new"]], "\nnew file contents\n");
4720 InitBasicFS, Always, TestOutput (
4721 [["write"; "/new"; "\n\n"];
4722 ["cat"; "/new"]], "\n\n");
4723 InitBasicFS, Always, TestOutput (
4724 [["write"; "/new"; ""];
4725 ["cat"; "/new"]], "");
4726 InitBasicFS, Always, TestOutput (
4727 [["write"; "/new"; "\n\n\n"];
4728 ["cat"; "/new"]], "\n\n\n");
4729 InitBasicFS, Always, TestOutput (
4730 [["write"; "/new"; "\n"];
4731 ["cat"; "/new"]], "\n")],
4732 "create a new file",
4734 This call creates a file called C<path>. The content of the
4735 file is the string C<content> (which can contain any 8 bit data).");
4737 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
4738 [InitBasicFS, Always, TestOutput (
4739 [["write"; "/new"; "new file contents"];
4740 ["pwrite"; "/new"; "data"; "4"];
4741 ["cat"; "/new"]], "new data contents");
4742 InitBasicFS, Always, TestOutput (
4743 [["write"; "/new"; "new file contents"];
4744 ["pwrite"; "/new"; "is extended"; "9"];
4745 ["cat"; "/new"]], "new file is extended");
4746 InitBasicFS, Always, TestOutput (
4747 [["write"; "/new"; "new file contents"];
4748 ["pwrite"; "/new"; ""; "4"];
4749 ["cat"; "/new"]], "new file contents")],
4750 "write to part of a file",
4752 This command writes to part of a file. It writes the data
4753 buffer C<content> to the file C<path> starting at offset C<offset>.
4755 This command implements the L<pwrite(2)> system call, and like
4756 that system call it may not write the full data requested. The
4757 return value is the number of bytes that were actually written
4758 to the file. This could even be 0, although short writes are
4759 unlikely for regular files in ordinary circumstances.
4761 See also C<guestfs_pread>.");
4763 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
4765 "resize an ext2, ext3 or ext4 filesystem (with size)",
4767 This command is the same as C<guestfs_resize2fs> except that it
4768 allows you to specify the new size (in bytes) explicitly.");
4770 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
4772 "resize an LVM physical volume (with size)",
4774 This command is the same as C<guestfs_pvresize> except that it
4775 allows you to specify the new size (in bytes) explicitly.");
4777 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"]), 250, [Optional "ntfsprogs"],
4779 "resize an NTFS filesystem (with size)",
4781 This command is the same as C<guestfs_ntfsresize> except that it
4782 allows you to specify the new size (in bytes) explicitly.");
4784 ("available_all_groups", (RStringList "groups", []), 251, [],
4785 [InitNone, Always, TestRun [["available_all_groups"]]],
4786 "return a list of all optional groups",
4788 This command returns a list of all optional groups that this
4789 daemon knows about. Note this returns both supported and unsupported
4790 groups. To find out which ones the daemon can actually support
4791 you have to call C<guestfs_available> on each member of the
4794 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4796 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"]), 252, [],
4797 [InitBasicFS, Always, TestOutputStruct (
4798 [["fallocate64"; "/a"; "1000000"];
4799 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4800 "preallocate a file in the guest filesystem",
4802 This command preallocates a file (containing zero bytes) named
4803 C<path> of size C<len> bytes. If the file exists already, it
4806 Note that this call allocates disk blocks for the file.
4807 To create a sparse file use C<guestfs_truncate_size> instead.
4809 The deprecated call C<guestfs_fallocate> does the same,
4810 but owing to an oversight it only allowed 30 bit lengths
4811 to be specified, effectively limiting the maximum size
4812 of files created through that call to 1GB.
4814 Do not confuse this with the guestfish-specific
4815 C<alloc> and C<sparse> commands which create
4816 a file in the host and attach it as a device.");
4818 ("vfs_label", (RString "label", [Device "device"]), 253, [],
4819 [InitBasicFS, Always, TestOutput (
4820 [["set_e2label"; "/dev/sda1"; "LTEST"];
4821 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4822 "get the filesystem label",
4824 This returns the filesystem label of the filesystem on
4827 If the filesystem is unlabeled, this returns the empty string.");
4829 ("vfs_uuid", (RString "uuid", [Device "device"]), 254, [],
4830 (let uuid = uuidgen () in
4831 [InitBasicFS, Always, TestOutput (
4832 [["set_e2uuid"; "/dev/sda1"; uuid];
4833 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4834 "get the filesystem UUID",
4836 This returns the filesystem UUID of the filesystem on
4839 If the filesystem does not have a UUID, this returns the empty string.");
4841 ("lvm_set_filter", (RErr, [DeviceList "devices"]), 255, [Optional "lvm2"],
4842 (* Can't be tested with the current framework because
4843 * the VG is being used by the mounted filesystem, so
4844 * the vgchange -an command we do first will fail.
4847 "set LVM device filter",
4849 This sets the LVM device filter so that LVM will only be
4850 able to \"see\" the block devices in the list C<devices>,
4851 and will ignore all other attached block devices.
4853 Where disk image(s) contain duplicate PVs or VGs, this
4854 command is useful to get LVM to ignore the duplicates, otherwise
4855 LVM can get confused. Note also there are two types
4856 of duplication possible: either cloned PVs/VGs which have
4857 identical UUIDs; or VGs that are not cloned but just happen
4858 to have the same name. In normal operation you cannot
4859 create this situation, but you can do it outside LVM, eg.
4860 by cloning disk images or by bit twiddling inside the LVM
4863 This command also clears the LVM cache and performs a volume
4866 You can filter whole block devices or individual partitions.
4868 You cannot use this if any VG is currently in use (eg.
4869 contains a mounted filesystem), even if you are not
4870 filtering out that VG.");
4872 ("lvm_clear_filter", (RErr, []), 256, [],
4873 [], (* see note on lvm_set_filter *)
4874 "clear LVM device filter",
4876 This undoes the effect of C<guestfs_lvm_set_filter>. LVM
4877 will be able to see every block device.
4879 This command also clears the LVM cache and performs a volume
4882 ("luks_open", (RErr, [Device "device"; Key "key"; String "mapname"]), 257, [Optional "luks"],
4884 "open a LUKS-encrypted block device",
4886 This command opens a block device which has been encrypted
4887 according to the Linux Unified Key Setup (LUKS) standard.
4889 C<device> is the encrypted block device or partition.
4891 The caller must supply one of the keys associated with the
4892 LUKS block device, in the C<key> parameter.
4894 This creates a new block device called C</dev/mapper/mapname>.
4895 Reads and writes to this block device are decrypted from and
4896 encrypted to the underlying C<device> respectively.
4898 If this block device contains LVM volume groups, then
4899 calling C<guestfs_vgscan> followed by C<guestfs_vg_activate_all>
4900 will make them visible.");
4902 ("luks_open_ro", (RErr, [Device "device"; Key "key"; String "mapname"]), 258, [Optional "luks"],
4904 "open a LUKS-encrypted block device read-only",
4906 This is the same as C<guestfs_luks_open> except that a read-only
4907 mapping is created.");
4909 ("luks_close", (RErr, [Device "device"]), 259, [Optional "luks"],
4911 "close a LUKS device",
4913 This closes a LUKS device that was created earlier by
4914 C<guestfs_luks_open> or C<guestfs_luks_open_ro>. The
4915 C<device> parameter must be the name of the LUKS mapping
4916 device (ie. C</dev/mapper/mapname>) and I<not> the name
4917 of the underlying block device.");
4919 ("luks_format", (RErr, [Device "device"; Key "key"; Int "keyslot"]), 260, [Optional "luks"; DangerWillRobinson],
4921 "format a block device as a LUKS encrypted device",
4923 This command erases existing data on C<device> and formats
4924 the device as a LUKS encrypted device. C<key> is the
4925 initial key, which is added to key slot C<slot>. (LUKS
4926 supports 8 key slots, numbered 0-7).");
4928 ("luks_format_cipher", (RErr, [Device "device"; Key "key"; Int "keyslot"; String "cipher"]), 261, [Optional "luks"; DangerWillRobinson],
4930 "format a block device as a LUKS encrypted device",
4932 This command is the same as C<guestfs_luks_format> but
4933 it also allows you to set the C<cipher> used.");
4935 ("luks_add_key", (RErr, [Device "device"; Key "key"; Key "newkey"; Int "keyslot"]), 262, [Optional "luks"],
4937 "add a key on a LUKS encrypted device",
4939 This command adds a new key on LUKS device C<device>.
4940 C<key> is any existing key, and is used to access the device.
4941 C<newkey> is the new key to add. C<keyslot> is the key slot
4942 that will be replaced.
4944 Note that if C<keyslot> already contains a key, then this
4945 command will fail. You have to use C<guestfs_luks_kill_slot>
4946 first to remove that key.");
4948 ("luks_kill_slot", (RErr, [Device "device"; Key "key"; Int "keyslot"]), 263, [Optional "luks"],
4950 "remove a key from a LUKS encrypted device",
4952 This command deletes the key in key slot C<keyslot> from the
4953 encrypted LUKS device C<device>. C<key> must be one of the
4956 ("is_lv", (RBool "lvflag", [Device "device"]), 264, [Optional "lvm2"],
4957 [InitBasicFSonLVM, IfAvailable "lvm2", TestOutputTrue (
4958 [["is_lv"; "/dev/VG/LV"]]);
4959 InitBasicFSonLVM, IfAvailable "lvm2", TestOutputFalse (
4960 [["is_lv"; "/dev/sda1"]])],
4961 "test if device is a logical volume",
4963 This command tests whether C<device> is a logical volume, and
4964 returns true iff this is the case.");
4968 let all_functions = non_daemon_functions @ daemon_functions
4970 (* In some places we want the functions to be displayed sorted
4971 * alphabetically, so this is useful:
4973 let all_functions_sorted =
4974 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4975 compare n1 n2) all_functions
4977 (* This is used to generate the src/MAX_PROC_NR file which
4978 * contains the maximum procedure number, a surrogate for the
4979 * ABI version number. See src/Makefile.am for the details.
4982 let proc_nrs = List.map (
4983 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4984 ) daemon_functions in
4985 List.fold_left max 0 proc_nrs
4987 (* Field types for structures. *)
4989 | FChar (* C 'char' (really, a 7 bit byte). *)
4990 | FString (* nul-terminated ASCII string, NOT NULL. *)
4991 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4996 | FBytes (* Any int measure that counts bytes. *)
4997 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4998 | FOptPercent (* [0..100], or -1 meaning "not present". *)
5000 (* Because we generate extra parsing code for LVM command line tools,
5001 * we have to pull out the LVM columns separately here.
5011 "pv_attr", FString (* XXX *);
5012 "pv_pe_count", FInt64;
5013 "pv_pe_alloc_count", FInt64;
5016 "pv_mda_count", FInt64;
5017 "pv_mda_free", FBytes;
5018 (* Not in Fedora 10:
5019 "pv_mda_size", FBytes;
5026 "vg_attr", FString (* XXX *);
5029 "vg_sysid", FString;
5030 "vg_extent_size", FBytes;
5031 "vg_extent_count", FInt64;
5032 "vg_free_count", FInt64;
5037 "snap_count", FInt64;
5040 "vg_mda_count", FInt64;
5041 "vg_mda_free", FBytes;
5042 (* Not in Fedora 10:
5043 "vg_mda_size", FBytes;
5049 "lv_attr", FString (* XXX *);
5052 "lv_kernel_major", FInt64;
5053 "lv_kernel_minor", FInt64;
5055 "seg_count", FInt64;
5057 "snap_percent", FOptPercent;
5058 "copy_percent", FOptPercent;
5061 "mirror_log", FString;
5065 (* Names and fields in all structures (in RStruct and RStructList)
5069 (* The old RIntBool return type, only ever used for aug_defnode. Do
5070 * not use this struct in any new code.
5073 "i", FInt32; (* for historical compatibility *)
5074 "b", FInt32; (* for historical compatibility *)
5077 (* LVM PVs, VGs, LVs. *)
5078 "lvm_pv", lvm_pv_cols;
5079 "lvm_vg", lvm_vg_cols;
5080 "lvm_lv", lvm_lv_cols;
5082 (* Column names and types from stat structures.
5083 * NB. Can't use things like 'st_atime' because glibc header files
5084 * define some of these as macros. Ugh.
5115 (* Column names in dirent structure. *)
5118 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
5123 (* Version numbers. *)
5131 (* Extended attribute. *)
5133 "attrname", FString;
5137 (* Inotify events. *)
5141 "in_cookie", FUInt32;
5145 (* Partition table entry. *)
5148 "part_start", FBytes;
5150 "part_size", FBytes;
5152 ] (* end of structs *)
5154 (* Ugh, Java has to be different ..
5155 * These names are also used by the Haskell bindings.
5157 let java_structs = [
5158 "int_bool", "IntBool";
5163 "statvfs", "StatVFS";
5165 "version", "Version";
5167 "inotify_event", "INotifyEvent";
5168 "partition", "Partition";
5171 (* What structs are actually returned. *)
5172 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
5174 (* Returns a list of RStruct/RStructList structs that are returned
5175 * by any function. Each element of returned list is a pair:
5177 * (structname, RStructOnly)
5178 * == there exists function which returns RStruct (_, structname)
5179 * (structname, RStructListOnly)
5180 * == there exists function which returns RStructList (_, structname)
5181 * (structname, RStructAndList)
5182 * == there are functions returning both RStruct (_, structname)
5183 * and RStructList (_, structname)
5185 let rstructs_used_by functions =
5186 (* ||| is a "logical OR" for rstructs_used_t *)
5190 | _, RStructAndList -> RStructAndList
5191 | RStructOnly, RStructListOnly
5192 | RStructListOnly, RStructOnly -> RStructAndList
5193 | RStructOnly, RStructOnly -> RStructOnly
5194 | RStructListOnly, RStructListOnly -> RStructListOnly
5197 let h = Hashtbl.create 13 in
5199 (* if elem->oldv exists, update entry using ||| operator,
5200 * else just add elem->newv to the hash
5202 let update elem newv =
5203 try let oldv = Hashtbl.find h elem in
5204 Hashtbl.replace h elem (newv ||| oldv)
5205 with Not_found -> Hashtbl.add h elem newv
5209 fun (_, style, _, _, _, _, _) ->
5210 match fst style with
5211 | RStruct (_, structname) -> update structname RStructOnly
5212 | RStructList (_, structname) -> update structname RStructListOnly
5216 (* return key->values as a list of (key,value) *)
5217 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
5219 (* Used for testing language bindings. *)
5221 | CallString of string
5222 | CallOptString of string option
5223 | CallStringList of string list
5225 | CallInt64 of int64
5227 | CallBuffer of string
5229 (* Used to memoize the result of pod2text. *)
5230 let pod2text_memo_filename = "src/.pod2text.data"
5231 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
5233 let chan = open_in pod2text_memo_filename in
5234 let v = input_value chan in
5238 _ -> Hashtbl.create 13
5239 let pod2text_memo_updated () =
5240 let chan = open_out pod2text_memo_filename in
5241 output_value chan pod2text_memo;
5244 (* Useful functions.
5245 * Note we don't want to use any external OCaml libraries which
5246 * makes this a bit harder than it should be.
5248 module StringMap = Map.Make (String)
5250 let failwithf fs = ksprintf failwith fs
5252 let unique = let i = ref 0 in fun () -> incr i; !i
5254 let replace_char s c1 c2 =
5255 let s2 = String.copy s in
5256 let r = ref false in
5257 for i = 0 to String.length s2 - 1 do
5258 if String.unsafe_get s2 i = c1 then (
5259 String.unsafe_set s2 i c2;
5263 if not !r then s else s2
5267 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5269 let triml ?(test = isspace) str =
5271 let n = ref (String.length str) in
5272 while !n > 0 && test str.[!i]; do
5277 else String.sub str !i !n
5279 let trimr ?(test = isspace) str =
5280 let n = ref (String.length str) in
5281 while !n > 0 && test str.[!n-1]; do
5284 if !n = String.length str then str
5285 else String.sub str 0 !n
5287 let trim ?(test = isspace) str =
5288 trimr ~test (triml ~test str)
5290 let rec find s sub =
5291 let len = String.length s in
5292 let sublen = String.length sub in
5294 if i <= len-sublen then (
5296 if j < sublen then (
5297 if s.[i+j] = sub.[j] then loop2 (j+1)
5303 if r = -1 then loop (i+1) else r
5309 let rec replace_str s s1 s2 =
5310 let len = String.length s in
5311 let sublen = String.length s1 in
5312 let i = find s s1 in
5315 let s' = String.sub s 0 i in
5316 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5317 s' ^ s2 ^ replace_str s'' s1 s2
5320 let rec string_split sep str =
5321 let len = String.length str in
5322 let seplen = String.length sep in
5323 let i = find str sep in
5324 if i = -1 then [str]
5326 let s' = String.sub str 0 i in
5327 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5328 s' :: string_split sep s''
5331 let files_equal n1 n2 =
5332 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5333 match Sys.command cmd with
5336 | i -> failwithf "%s: failed with error code %d" cmd i
5338 let rec filter_map f = function
5342 | Some y -> y :: filter_map f xs
5343 | None -> filter_map f xs
5345 let rec find_map f = function
5346 | [] -> raise Not_found
5350 | None -> find_map f xs
5353 let rec loop i = function
5355 | x :: xs -> f i x; loop (i+1) xs
5360 let rec loop i = function
5362 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5366 let count_chars c str =
5367 let count = ref 0 in
5368 for i = 0 to String.length str - 1 do
5369 if c = String.unsafe_get str i then incr count
5375 for i = 0 to String.length str - 1 do
5376 let c = String.unsafe_get str i in
5381 let map_chars f str =
5382 List.map f (explode str)
5384 let name_of_argt = function
5385 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5386 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5387 | FileIn n | FileOut n | BufferIn n | Key n -> n
5389 let java_name_of_struct typ =
5390 try List.assoc typ java_structs
5393 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5395 let cols_of_struct typ =
5396 try List.assoc typ structs
5398 failwithf "cols_of_struct: unknown struct %s" typ
5400 let seq_of_test = function
5401 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5402 | TestOutputListOfDevices (s, _)
5403 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5404 | TestOutputTrue s | TestOutputFalse s
5405 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5406 | TestOutputStruct (s, _)
5407 | TestLastFail s -> s
5409 (* Handling for function flags. *)
5410 let protocol_limit_warning =
5411 "Because of the message protocol, there is a transfer limit
5412 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5414 let danger_will_robinson =
5415 "B<This command is dangerous. Without careful use you
5416 can easily destroy all your data>."
5418 let deprecation_notice flags =
5421 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5423 sprintf "This function is deprecated.
5424 In new code, use the C<%s> call instead.
5426 Deprecated functions will not be removed from the API, but the
5427 fact that they are deprecated indicates that there are problems
5428 with correct use of these functions." alt in
5433 (* Create list of optional groups. *)
5435 let h = Hashtbl.create 13 in
5437 fun (name, _, _, flags, _, _, _) ->
5441 let names = try Hashtbl.find h group with Not_found -> [] in
5442 Hashtbl.replace h group (name :: names)
5446 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5449 fun group -> group, List.sort compare (Hashtbl.find h group)
5451 List.sort (fun x y -> compare (fst x) (fst y)) groups
5453 (* Check function names etc. for consistency. *)
5454 let check_functions () =
5455 let contains_uppercase str =
5456 let len = String.length str in
5458 if i >= len then false
5461 if c >= 'A' && c <= 'Z' then true
5468 (* Check function names. *)
5470 fun (name, _, _, _, _, _, _) ->
5471 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5472 failwithf "function name %s does not need 'guestfs' prefix" name;
5474 failwithf "function name is empty";
5475 if name.[0] < 'a' || name.[0] > 'z' then
5476 failwithf "function name %s must start with lowercase a-z" name;
5477 if String.contains name '-' then
5478 failwithf "function name %s should not contain '-', use '_' instead."
5482 (* Check function parameter/return names. *)
5484 fun (name, style, _, _, _, _, _) ->
5485 let check_arg_ret_name n =
5486 if contains_uppercase n then
5487 failwithf "%s param/ret %s should not contain uppercase chars"
5489 if String.contains n '-' || String.contains n '_' then
5490 failwithf "%s param/ret %s should not contain '-' or '_'"
5493 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;
5494 if n = "int" || n = "char" || n = "short" || n = "long" then
5495 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5496 if n = "i" || n = "n" then
5497 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5498 if n = "argv" || n = "args" then
5499 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5501 (* List Haskell, OCaml and C keywords here.
5502 * http://www.haskell.org/haskellwiki/Keywords
5503 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5504 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5505 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5506 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5507 * Omitting _-containing words, since they're handled above.
5508 * Omitting the OCaml reserved word, "val", is ok,
5509 * and saves us from renaming several parameters.
5512 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5513 "char"; "class"; "const"; "constraint"; "continue"; "data";
5514 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5515 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5516 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5517 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5518 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5520 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5521 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5522 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5523 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5524 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5525 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5526 "volatile"; "when"; "where"; "while";
5528 if List.mem n reserved then
5529 failwithf "%s has param/ret using reserved word %s" name n;
5532 (match fst style with
5534 | RInt n | RInt64 n | RBool n
5535 | RConstString n | RConstOptString n | RString n
5536 | RStringList n | RStruct (n, _) | RStructList (n, _)
5537 | RHashtable n | RBufferOut n ->
5538 check_arg_ret_name n
5540 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5543 (* Check short descriptions. *)
5545 fun (name, _, _, _, _, shortdesc, _) ->
5546 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5547 failwithf "short description of %s should begin with lowercase." name;
5548 let c = shortdesc.[String.length shortdesc-1] in
5549 if c = '\n' || c = '.' then
5550 failwithf "short description of %s should not end with . or \\n." name
5553 (* Check long descriptions. *)
5555 fun (name, _, _, _, _, _, longdesc) ->
5556 if longdesc.[String.length longdesc-1] = '\n' then
5557 failwithf "long description of %s should not end with \\n." name
5560 (* Check proc_nrs. *)
5562 fun (name, _, proc_nr, _, _, _, _) ->
5563 if proc_nr <= 0 then
5564 failwithf "daemon function %s should have proc_nr > 0" name
5568 fun (name, _, proc_nr, _, _, _, _) ->
5569 if proc_nr <> -1 then
5570 failwithf "non-daemon function %s should have proc_nr -1" name
5571 ) non_daemon_functions;
5574 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5577 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5578 let rec loop = function
5581 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5583 | (name1,nr1) :: (name2,nr2) :: _ ->
5584 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5592 (* Ignore functions that have no tests. We generate a
5593 * warning when the user does 'make check' instead.
5595 | name, _, _, _, [], _, _ -> ()
5596 | name, _, _, _, tests, _, _ ->
5600 match seq_of_test test with
5602 failwithf "%s has a test containing an empty sequence" name
5603 | cmds -> List.map List.hd cmds
5605 let funcs = List.flatten funcs in
5607 let tested = List.mem name funcs in
5610 failwithf "function %s has tests but does not test itself" name
5613 (* 'pr' prints to the current output file. *)
5614 let chan = ref Pervasives.stdout
5619 let i = count_chars '\n' str in
5620 lines := !lines + i;
5621 output_string !chan str
5624 let copyright_years =
5625 let this_year = 1900 + (localtime (time ())).tm_year in
5626 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5628 (* Generate a header block in a number of standard styles. *)
5629 type comment_style =
5630 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5631 type license = GPLv2plus | LGPLv2plus
5633 let generate_header ?(extra_inputs = []) comment license =
5634 let inputs = "src/generator.ml" :: extra_inputs in
5635 let c = match comment with
5636 | CStyle -> pr "/* "; " *"
5637 | CPlusPlusStyle -> pr "// "; "//"
5638 | HashStyle -> pr "# "; "#"
5639 | OCamlStyle -> pr "(* "; " *"
5640 | HaskellStyle -> pr "{- "; " " in
5641 pr "libguestfs generated file\n";
5642 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5643 List.iter (pr "%s %s\n" c) inputs;
5644 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5646 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5650 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5651 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5652 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5653 pr "%s (at your option) any later version.\n" c;
5655 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5656 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5657 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5658 pr "%s GNU General Public License for more details.\n" c;
5660 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5661 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5662 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5665 pr "%s This library is free software; you can redistribute it and/or\n" c;
5666 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5667 pr "%s License as published by the Free Software Foundation; either\n" c;
5668 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5670 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5671 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5672 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5673 pr "%s Lesser General Public License for more details.\n" c;
5675 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5676 pr "%s License along with this library; if not, write to the Free Software\n" c;
5677 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5680 | CStyle -> pr " */\n"
5683 | OCamlStyle -> pr " *)\n"
5684 | HaskellStyle -> pr "-}\n"
5688 (* Start of main code generation functions below this line. *)
5690 (* Generate the pod documentation for the C API. *)
5691 let rec generate_actions_pod () =
5693 fun (shortname, style, _, flags, _, _, longdesc) ->
5694 if not (List.mem NotInDocs flags) then (
5695 let name = "guestfs_" ^ shortname in
5696 pr "=head2 %s\n\n" name;
5698 generate_prototype ~extern:false ~handle:"g" name style;
5700 pr "%s\n\n" longdesc;
5701 (match fst style with
5703 pr "This function returns 0 on success or -1 on error.\n\n"
5705 pr "On error this function returns -1.\n\n"
5707 pr "On error this function returns -1.\n\n"
5709 pr "This function returns a C truth value on success or -1 on error.\n\n"
5711 pr "This function returns a string, or NULL on error.
5712 The string is owned by the guest handle and must I<not> be freed.\n\n"
5713 | RConstOptString _ ->
5714 pr "This function returns a string which may be NULL.
5715 There is no way to return an error from this function.
5716 The string is owned by the guest handle and must I<not> be freed.\n\n"
5718 pr "This function returns a string, or NULL on error.
5719 I<The caller must free the returned string after use>.\n\n"
5721 pr "This function returns a NULL-terminated array of strings
5722 (like L<environ(3)>), or NULL if there was an error.
5723 I<The caller must free the strings and the array after use>.\n\n"
5724 | RStruct (_, typ) ->
5725 pr "This function returns a C<struct guestfs_%s *>,
5726 or NULL if there was an error.
5727 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5728 | RStructList (_, typ) ->
5729 pr "This function returns a C<struct guestfs_%s_list *>
5730 (see E<lt>guestfs-structs.hE<gt>),
5731 or NULL if there was an error.
5732 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5734 pr "This function returns a NULL-terminated array of
5735 strings, or NULL if there was an error.
5736 The array of strings will always have length C<2n+1>, where
5737 C<n> keys and values alternate, followed by the trailing NULL entry.
5738 I<The caller must free the strings and the array after use>.\n\n"
5740 pr "This function returns a buffer, or NULL on error.
5741 The size of the returned buffer is written to C<*size_r>.
5742 I<The caller must free the returned buffer after use>.\n\n"
5744 if List.mem ProtocolLimitWarning flags then
5745 pr "%s\n\n" protocol_limit_warning;
5746 if List.mem DangerWillRobinson flags then
5747 pr "%s\n\n" danger_will_robinson;
5748 if List.exists (function Key _ -> true | _ -> false) (snd style) then
5749 pr "This function takes a key or passphrase parameter which
5750 could contain sensitive material. Read the section
5751 L</KEYS AND PASSPHRASES> for more information.\n\n";
5752 match deprecation_notice flags with
5754 | Some txt -> pr "%s\n\n" txt
5756 ) all_functions_sorted
5758 and generate_structs_pod () =
5759 (* Structs documentation. *)
5762 pr "=head2 guestfs_%s\n" typ;
5764 pr " struct guestfs_%s {\n" typ;
5767 | name, FChar -> pr " char %s;\n" name
5768 | name, FUInt32 -> pr " uint32_t %s;\n" name
5769 | name, FInt32 -> pr " int32_t %s;\n" name
5770 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5771 | name, FInt64 -> pr " int64_t %s;\n" name
5772 | name, FString -> pr " char *%s;\n" name
5774 pr " /* The next two fields describe a byte array. */\n";
5775 pr " uint32_t %s_len;\n" name;
5776 pr " char *%s;\n" name
5778 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5779 pr " char %s[32];\n" name
5780 | name, FOptPercent ->
5781 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5782 pr " float %s;\n" name
5786 pr " struct guestfs_%s_list {\n" typ;
5787 pr " uint32_t len; /* Number of elements in list. */\n";
5788 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5791 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5792 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5797 and generate_availability_pod () =
5798 (* Availability documentation. *)
5802 fun (group, functions) ->
5803 pr "=item B<%s>\n" group;
5805 pr "The following functions:\n";
5806 List.iter (pr "L</guestfs_%s>\n") functions;
5812 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5813 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5815 * We have to use an underscore instead of a dash because otherwise
5816 * rpcgen generates incorrect code.
5818 * This header is NOT exported to clients, but see also generate_structs_h.
5820 and generate_xdr () =
5821 generate_header CStyle LGPLv2plus;
5823 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5824 pr "typedef string str<>;\n";
5827 (* Internal structures. *)
5831 pr "struct guestfs_int_%s {\n" typ;
5833 | name, FChar -> pr " char %s;\n" name
5834 | name, FString -> pr " string %s<>;\n" name
5835 | name, FBuffer -> pr " opaque %s<>;\n" name
5836 | name, FUUID -> pr " opaque %s[32];\n" name
5837 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5838 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5839 | name, FOptPercent -> pr " float %s;\n" name
5843 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5848 fun (shortname, style, _, _, _, _, _) ->
5849 let name = "guestfs_" ^ shortname in
5851 (match snd style with
5854 pr "struct %s_args {\n" name;
5857 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
5858 pr " string %s<>;\n" n
5859 | OptString n -> pr " str *%s;\n" n
5860 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5861 | Bool n -> pr " bool %s;\n" n
5862 | Int n -> pr " int %s;\n" n
5863 | Int64 n -> pr " hyper %s;\n" n
5865 pr " opaque %s<>;\n" n
5866 | FileIn _ | FileOut _ -> ()
5870 (match fst style with
5873 pr "struct %s_ret {\n" name;
5877 pr "struct %s_ret {\n" name;
5878 pr " hyper %s;\n" n;
5881 pr "struct %s_ret {\n" name;
5884 | RConstString _ | RConstOptString _ ->
5885 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5887 pr "struct %s_ret {\n" name;
5888 pr " string %s<>;\n" n;
5891 pr "struct %s_ret {\n" name;
5892 pr " str %s<>;\n" n;
5894 | RStruct (n, typ) ->
5895 pr "struct %s_ret {\n" name;
5896 pr " guestfs_int_%s %s;\n" typ n;
5898 | RStructList (n, typ) ->
5899 pr "struct %s_ret {\n" name;
5900 pr " guestfs_int_%s_list %s;\n" typ n;
5903 pr "struct %s_ret {\n" name;
5904 pr " str %s<>;\n" n;
5907 pr "struct %s_ret {\n" name;
5908 pr " opaque %s<>;\n" n;
5913 (* Table of procedure numbers. *)
5914 pr "enum guestfs_procedure {\n";
5916 fun (shortname, _, proc_nr, _, _, _, _) ->
5917 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5919 pr " GUESTFS_PROC_NR_PROCS\n";
5923 (* Having to choose a maximum message size is annoying for several
5924 * reasons (it limits what we can do in the API), but it (a) makes
5925 * the protocol a lot simpler, and (b) provides a bound on the size
5926 * of the daemon which operates in limited memory space.
5928 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5931 (* Message header, etc. *)
5933 /* The communication protocol is now documented in the guestfs(3)
5937 const GUESTFS_PROGRAM = 0x2000F5F5;
5938 const GUESTFS_PROTOCOL_VERSION = 1;
5940 /* These constants must be larger than any possible message length. */
5941 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5942 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5944 enum guestfs_message_direction {
5945 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5946 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5949 enum guestfs_message_status {
5950 GUESTFS_STATUS_OK = 0,
5951 GUESTFS_STATUS_ERROR = 1
5954 const GUESTFS_ERROR_LEN = 256;
5956 struct guestfs_message_error {
5957 string error_message<GUESTFS_ERROR_LEN>;
5960 struct guestfs_message_header {
5961 unsigned prog; /* GUESTFS_PROGRAM */
5962 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5963 guestfs_procedure proc; /* GUESTFS_PROC_x */
5964 guestfs_message_direction direction;
5965 unsigned serial; /* message serial number */
5966 guestfs_message_status status;
5969 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5971 struct guestfs_chunk {
5972 int cancel; /* if non-zero, transfer is cancelled */
5973 /* data size is 0 bytes if the transfer has finished successfully */
5974 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5978 (* Generate the guestfs-structs.h file. *)
5979 and generate_structs_h () =
5980 generate_header CStyle LGPLv2plus;
5982 (* This is a public exported header file containing various
5983 * structures. The structures are carefully written to have
5984 * exactly the same in-memory format as the XDR structures that
5985 * we use on the wire to the daemon. The reason for creating
5986 * copies of these structures here is just so we don't have to
5987 * export the whole of guestfs_protocol.h (which includes much
5988 * unrelated and XDR-dependent stuff that we don't want to be
5989 * public, or required by clients).
5991 * To reiterate, we will pass these structures to and from the
5992 * client with a simple assignment or memcpy, so the format
5993 * must be identical to what rpcgen / the RFC defines.
5996 (* Public structures. *)
5999 pr "struct guestfs_%s {\n" typ;
6002 | name, FChar -> pr " char %s;\n" name
6003 | name, FString -> pr " char *%s;\n" name
6005 pr " uint32_t %s_len;\n" name;
6006 pr " char *%s;\n" name
6007 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
6008 | name, FUInt32 -> pr " uint32_t %s;\n" name
6009 | name, FInt32 -> pr " int32_t %s;\n" name
6010 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
6011 | name, FInt64 -> pr " int64_t %s;\n" name
6012 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
6016 pr "struct guestfs_%s_list {\n" typ;
6017 pr " uint32_t len;\n";
6018 pr " struct guestfs_%s *val;\n" typ;
6021 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
6022 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
6026 (* Generate the guestfs-actions.h file. *)
6027 and generate_actions_h () =
6028 generate_header CStyle LGPLv2plus;
6030 fun (shortname, style, _, _, _, _, _) ->
6031 let name = "guestfs_" ^ shortname in
6032 generate_prototype ~single_line:true ~newline:true ~handle:"g"
6036 (* Generate the guestfs-internal-actions.h file. *)
6037 and generate_internal_actions_h () =
6038 generate_header CStyle LGPLv2plus;
6040 fun (shortname, style, _, _, _, _, _) ->
6041 let name = "guestfs__" ^ shortname in
6042 generate_prototype ~single_line:true ~newline:true ~handle:"g"
6044 ) non_daemon_functions
6046 (* Generate the client-side dispatch stubs. *)
6047 and generate_client_actions () =
6048 generate_header CStyle LGPLv2plus;
6055 #include <inttypes.h>
6057 #include \"guestfs.h\"
6058 #include \"guestfs-internal.h\"
6059 #include \"guestfs-internal-actions.h\"
6060 #include \"guestfs_protocol.h\"
6062 /* Check the return message from a call for validity. */
6064 check_reply_header (guestfs_h *g,
6065 const struct guestfs_message_header *hdr,
6066 unsigned int proc_nr, unsigned int serial)
6068 if (hdr->prog != GUESTFS_PROGRAM) {
6069 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
6072 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
6073 error (g, \"wrong protocol version (%%d/%%d)\",
6074 hdr->vers, GUESTFS_PROTOCOL_VERSION);
6077 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
6078 error (g, \"unexpected message direction (%%d/%%d)\",
6079 hdr->direction, GUESTFS_DIRECTION_REPLY);
6082 if (hdr->proc != proc_nr) {
6083 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
6086 if (hdr->serial != serial) {
6087 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
6094 /* Check we are in the right state to run a high-level action. */
6096 check_state (guestfs_h *g, const char *caller)
6098 if (!guestfs__is_ready (g)) {
6099 if (guestfs__is_config (g) || guestfs__is_launching (g))
6100 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
6103 error (g, \"%%s called from the wrong state, %%d != READY\",
6104 caller, guestfs__get_state (g));
6112 let error_code_of = function
6113 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
6114 | RConstString _ | RConstOptString _
6115 | RString _ | RStringList _
6116 | RStruct _ | RStructList _
6117 | RHashtable _ | RBufferOut _ -> "NULL"
6120 (* Generate code to check String-like parameters are not passed in
6121 * as NULL (returning an error if they are).
6123 let check_null_strings shortname style =
6124 let pr_newline = ref false in
6127 (* parameters which should not be NULL *)
6138 pr " if (%s == NULL) {\n" n;
6139 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
6140 pr " \"%s\", \"%s\");\n" shortname n;
6141 pr " return %s;\n" (error_code_of (fst style));
6148 (* not applicable *)
6154 if !pr_newline then pr "\n";
6157 (* Generate code to generate guestfish call traces. *)
6158 let trace_call shortname style =
6159 pr " if (guestfs__get_trace (g)) {\n";
6162 List.exists (function
6163 | StringList _ | DeviceList _ -> true
6164 | _ -> false) (snd style) in
6170 pr " fprintf (stderr, \"%s\");\n" shortname;
6173 | String n (* strings *)
6181 (* guestfish doesn't support string escaping, so neither do we *)
6182 pr " fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n
6183 | OptString n -> (* string option *)
6184 pr " if (%s) fprintf (stderr, \" \\\"%%s\\\"\", %s);\n" n n;
6185 pr " else fprintf (stderr, \" null\");\n"
6187 | DeviceList n -> (* string list *)
6188 pr " fputc (' ', stderr);\n";
6189 pr " fputc ('\"', stderr);\n";
6190 pr " for (i = 0; %s[i]; ++i) {\n" n;
6191 pr " if (i > 0) fputc (' ', stderr);\n";
6192 pr " fputs (%s[i], stderr);\n" n;
6194 pr " fputc ('\"', stderr);\n";
6195 | Bool n -> (* boolean *)
6196 pr " fputs (%s ? \" true\" : \" false\", stderr);\n" n
6197 | Int n -> (* int *)
6198 pr " fprintf (stderr, \" %%d\", %s);\n" n
6200 pr " fprintf (stderr, \" %%\" PRIi64, %s);\n" n
6202 pr " fputc ('\\n', stderr);\n";
6207 (* For non-daemon functions, generate a wrapper around each function. *)
6209 fun (shortname, style, _, _, _, _, _) ->
6210 let name = "guestfs_" ^ shortname in
6212 generate_prototype ~extern:false ~semicolon:false ~newline:true
6213 ~handle:"g" name style;
6215 check_null_strings shortname style;
6216 trace_call shortname style;
6217 pr " return guestfs__%s " shortname;
6218 generate_c_call_args ~handle:"g" style;
6222 ) non_daemon_functions;
6224 (* Client-side stubs for each function. *)
6226 fun (shortname, style, _, _, _, _, _) ->
6227 let name = "guestfs_" ^ shortname in
6228 let error_code = error_code_of (fst style) in
6230 (* Generate the action stub. *)
6231 generate_prototype ~extern:false ~semicolon:false ~newline:true
6232 ~handle:"g" name style;
6236 (match snd style with
6238 | _ -> pr " struct %s_args args;\n" name
6241 pr " guestfs_message_header hdr;\n";
6242 pr " guestfs_message_error err;\n";
6244 match fst style with
6246 | RConstString _ | RConstOptString _ ->
6247 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6249 | RBool _ | RString _ | RStringList _
6250 | RStruct _ | RStructList _
6251 | RHashtable _ | RBufferOut _ ->
6252 pr " struct %s_ret ret;\n" name;
6255 pr " int serial;\n";
6258 check_null_strings shortname style;
6259 trace_call shortname style;
6260 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
6261 shortname error_code;
6262 pr " guestfs___set_busy (g);\n";
6265 (* Send the main header and arguments. *)
6266 (match snd style with
6268 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6269 (String.uppercase shortname)
6273 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
6274 pr " args.%s = (char *) %s;\n" n n
6276 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6277 | StringList n | DeviceList n ->
6278 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6279 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6281 pr " args.%s = %s;\n" n n
6283 pr " args.%s = %s;\n" n n
6285 pr " args.%s = %s;\n" n n
6286 | FileIn _ | FileOut _ -> ()
6288 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6289 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6290 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6292 pr " guestfs___end_busy (g);\n";
6293 pr " return %s;\n" error_code;
6295 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6296 pr " args.%s.%s_len = %s_size;\n" n n n
6298 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6299 (String.uppercase shortname);
6300 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6303 pr " if (serial == -1) {\n";
6304 pr " guestfs___end_busy (g);\n";
6305 pr " return %s;\n" error_code;
6309 (* Send any additional files (FileIn) requested. *)
6310 let need_read_reply_label = ref false in
6314 pr " r = guestfs___send_file (g, %s);\n" n;
6315 pr " if (r == -1) {\n";
6316 pr " guestfs___end_busy (g);\n";
6317 pr " return %s;\n" error_code;
6319 pr " if (r == -2) /* daemon cancelled */\n";
6320 pr " goto read_reply;\n";
6321 need_read_reply_label := true;
6326 (* Wait for the reply from the remote end. *)
6327 if !need_read_reply_label then pr " read_reply:\n";
6328 pr " memset (&hdr, 0, sizeof hdr);\n";
6329 pr " memset (&err, 0, sizeof err);\n";
6330 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6332 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6336 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6339 pr " if (r == -1) {\n";
6340 pr " guestfs___end_busy (g);\n";
6341 pr " return %s;\n" error_code;
6345 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6346 (String.uppercase shortname);
6347 pr " guestfs___end_busy (g);\n";
6348 pr " return %s;\n" error_code;
6352 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6353 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6354 pr " free (err.error_message);\n";
6355 pr " guestfs___end_busy (g);\n";
6356 pr " return %s;\n" error_code;
6360 (* Expecting to receive further files (FileOut)? *)
6364 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6365 pr " guestfs___end_busy (g);\n";
6366 pr " return %s;\n" error_code;
6372 pr " guestfs___end_busy (g);\n";
6374 (match fst style with
6375 | RErr -> pr " return 0;\n"
6376 | RInt n | RInt64 n | RBool n ->
6377 pr " return ret.%s;\n" n
6378 | RConstString _ | RConstOptString _ ->
6379 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6381 pr " return ret.%s; /* caller will free */\n" n
6382 | RStringList n | RHashtable n ->
6383 pr " /* caller will free this, but we need to add a NULL entry */\n";
6384 pr " ret.%s.%s_val =\n" n n;
6385 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6386 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6388 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6389 pr " return ret.%s.%s_val;\n" n n
6391 pr " /* caller will free this */\n";
6392 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6393 | RStructList (n, _) ->
6394 pr " /* caller will free this */\n";
6395 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6397 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6398 pr " * _val might be NULL here. To make the API saner for\n";
6399 pr " * callers, we turn this case into a unique pointer (using\n";
6400 pr " * malloc(1)).\n";
6402 pr " if (ret.%s.%s_len > 0) {\n" n n;
6403 pr " *size_r = ret.%s.%s_len;\n" n n;
6404 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6406 pr " free (ret.%s.%s_val);\n" n n;
6407 pr " char *p = safe_malloc (g, 1);\n";
6408 pr " *size_r = ret.%s.%s_len;\n" n n;
6416 (* Functions to free structures. *)
6417 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6418 pr " * structure format is identical to the XDR format. See note in\n";
6419 pr " * generator.ml.\n";
6426 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6428 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6434 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6436 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6443 (* Generate daemon/actions.h. *)
6444 and generate_daemon_actions_h () =
6445 generate_header CStyle GPLv2plus;
6447 pr "#include \"../src/guestfs_protocol.h\"\n";
6451 fun (name, style, _, _, _, _, _) ->
6453 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6457 (* Generate the linker script which controls the visibility of
6458 * symbols in the public ABI and ensures no other symbols get
6459 * exported accidentally.
6461 and generate_linker_script () =
6462 generate_header HashStyle GPLv2plus;
6467 "guestfs_get_error_handler";
6468 "guestfs_get_out_of_memory_handler";
6469 "guestfs_last_error";
6470 "guestfs_set_close_callback";
6471 "guestfs_set_error_handler";
6472 "guestfs_set_launch_done_callback";
6473 "guestfs_set_log_message_callback";
6474 "guestfs_set_out_of_memory_handler";
6475 "guestfs_set_subprocess_quit_callback";
6477 (* Unofficial parts of the API: the bindings code use these
6478 * functions, so it is useful to export them.
6480 "guestfs_safe_calloc";
6481 "guestfs_safe_malloc";
6482 "guestfs_safe_strdup";
6483 "guestfs_safe_memdup";
6486 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6490 List.map (fun (typ, _) ->
6491 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6494 let globals = List.sort compare (globals @ functions @ structs) in
6498 List.iter (pr " %s;\n") globals;
6505 (* Generate the server-side stubs. *)
6506 and generate_daemon_actions () =
6507 generate_header CStyle GPLv2plus;
6509 pr "#include <config.h>\n";
6511 pr "#include <stdio.h>\n";
6512 pr "#include <stdlib.h>\n";
6513 pr "#include <string.h>\n";
6514 pr "#include <inttypes.h>\n";
6515 pr "#include <rpc/types.h>\n";
6516 pr "#include <rpc/xdr.h>\n";
6518 pr "#include \"daemon.h\"\n";
6519 pr "#include \"c-ctype.h\"\n";
6520 pr "#include \"../src/guestfs_protocol.h\"\n";
6521 pr "#include \"actions.h\"\n";
6525 fun (name, style, _, _, _, _, _) ->
6526 (* Generate server-side stubs. *)
6527 pr "static void %s_stub (XDR *xdr_in)\n" name;
6530 match fst style with
6531 | RErr | RInt _ -> pr " int r;\n"; "-1"
6532 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6533 | RBool _ -> pr " int r;\n"; "-1"
6534 | RConstString _ | RConstOptString _ ->
6535 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6536 | RString _ -> pr " char *r;\n"; "NULL"
6537 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6538 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6539 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6541 pr " size_t size = 1;\n";
6545 (match snd style with
6548 pr " struct guestfs_%s_args args;\n" name;
6551 | Device n | Dev_or_Path n
6555 | OptString n -> pr " char *%s;\n" n
6556 | StringList n | DeviceList n -> pr " char **%s;\n" n
6557 | Bool n -> pr " int %s;\n" n
6558 | Int n -> pr " int %s;\n" n
6559 | Int64 n -> pr " int64_t %s;\n" n
6560 | FileIn _ | FileOut _ -> ()
6562 pr " const char *%s;\n" n;
6563 pr " size_t %s_size;\n" n
6569 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6571 (match snd style with
6574 pr " memset (&args, 0, sizeof args);\n";
6576 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6578 pr " if (cancel_receive () != -2)\n";
6579 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6583 pr " char *%s = args.%s;\n" n n
6585 let pr_list_handling_code n =
6586 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6587 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6588 pr " if (%s == NULL) {\n" n;
6590 pr " if (cancel_receive () != -2)\n";
6591 pr " reply_with_perror (\"realloc\");\n";
6594 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6595 pr " args.%s.%s_val = %s;\n" n n n;
6601 pr " ABS_PATH (%s, %s, goto done);\n"
6602 n (if is_filein then "cancel_receive ()" else "0");
6605 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6606 n (if is_filein then "cancel_receive ()" else "0");
6609 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6610 n (if is_filein then "cancel_receive ()" else "0");
6611 | String n | Key n -> pr_args n
6612 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6614 pr_list_handling_code n;
6616 pr_list_handling_code n;
6617 pr " /* Ensure that each is a device,\n";
6618 pr " * and perform device name translation.\n";
6622 pr " for (i = 0; %s[i] != NULL; ++i)\n" n;
6623 pr " RESOLVE_DEVICE (%s[i], %s, goto done);\n" n
6624 (if is_filein then "cancel_receive ()" else "0");
6626 | Bool n -> pr " %s = args.%s;\n" n n
6627 | Int n -> pr " %s = args.%s;\n" n n
6628 | Int64 n -> pr " %s = args.%s;\n" n n
6629 | FileIn _ | FileOut _ -> ()
6631 pr " %s = args.%s.%s_val;\n" n n n;
6632 pr " %s_size = args.%s.%s_len;\n" n n n
6637 (* this is used at least for do_equal *)
6638 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6639 (* Emit NEED_ROOT just once, even when there are two or
6640 more Pathname args *)
6641 pr " NEED_ROOT (%s, goto done);\n"
6642 (if is_filein then "cancel_receive ()" else "0");
6645 (* Don't want to call the impl with any FileIn or FileOut
6646 * parameters, since these go "outside" the RPC protocol.
6649 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6651 pr " r = do_%s " name;
6652 generate_c_call_args (fst style, args');
6655 (match fst style with
6656 | RErr | RInt _ | RInt64 _ | RBool _
6657 | RConstString _ | RConstOptString _
6658 | RString _ | RStringList _ | RHashtable _
6659 | RStruct (_, _) | RStructList (_, _) ->
6660 pr " if (r == %s)\n" error_code;
6661 pr " /* do_%s has already called reply_with_error */\n" name;
6665 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6666 pr " * an ordinary zero-length buffer), so be careful ...\n";
6668 pr " if (size == 1 && r == %s)\n" error_code;
6669 pr " /* do_%s has already called reply_with_error */\n" name;
6674 (* If there are any FileOut parameters, then the impl must
6675 * send its own reply.
6678 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6680 pr " /* do_%s has already sent a reply */\n" name
6682 match fst style with
6683 | RErr -> pr " reply (NULL, NULL);\n"
6684 | RInt n | RInt64 n | RBool n ->
6685 pr " struct guestfs_%s_ret ret;\n" name;
6686 pr " ret.%s = r;\n" n;
6687 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6689 | RConstString _ | RConstOptString _ ->
6690 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6692 pr " struct guestfs_%s_ret ret;\n" name;
6693 pr " ret.%s = r;\n" n;
6694 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6697 | RStringList n | RHashtable n ->
6698 pr " struct guestfs_%s_ret ret;\n" name;
6699 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6700 pr " ret.%s.%s_val = r;\n" n n;
6701 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6703 pr " free_strings (r);\n"
6705 pr " struct guestfs_%s_ret ret;\n" name;
6706 pr " ret.%s = *r;\n" n;
6707 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6709 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6711 | RStructList (n, _) ->
6712 pr " struct guestfs_%s_ret ret;\n" name;
6713 pr " ret.%s = *r;\n" n;
6714 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6716 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6719 pr " struct guestfs_%s_ret ret;\n" name;
6720 pr " ret.%s.%s_val = r;\n" n n;
6721 pr " ret.%s.%s_len = size;\n" n n;
6722 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6727 (* Free the args. *)
6729 (match snd style with
6732 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6739 (* Dispatch function. *)
6740 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6742 pr " switch (proc_nr) {\n";
6745 fun (name, style, _, _, _, _, _) ->
6746 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6747 pr " %s_stub (xdr_in);\n" name;
6752 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";
6757 (* LVM columns and tokenization functions. *)
6758 (* XXX This generates crap code. We should rethink how we
6764 pr "static const char *lvm_%s_cols = \"%s\";\n"
6765 typ (String.concat "," (List.map fst cols));
6768 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6770 pr " char *tok, *p, *next;\n";
6771 pr " size_t i, j;\n";
6774 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6777 pr " if (!str) {\n";
6778 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6781 pr " if (!*str || c_isspace (*str)) {\n";
6782 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6787 fun (name, coltype) ->
6788 pr " if (!tok) {\n";
6789 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6792 pr " p = strchrnul (tok, ',');\n";
6793 pr " if (*p) next = p+1; else next = NULL;\n";
6794 pr " *p = '\\0';\n";
6797 pr " r->%s = strdup (tok);\n" name;
6798 pr " if (r->%s == NULL) {\n" name;
6799 pr " perror (\"strdup\");\n";
6803 pr " for (i = j = 0; i < 32; ++j) {\n";
6804 pr " if (tok[j] == '\\0') {\n";
6805 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6807 pr " } else if (tok[j] != '-')\n";
6808 pr " r->%s[i++] = tok[j];\n" name;
6811 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6812 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6816 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6817 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6821 pr " if (tok[0] == '\\0')\n";
6822 pr " r->%s = -1;\n" name;
6823 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6824 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6827 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6828 assert false (* can never be an LVM column *)
6830 pr " tok = next;\n";
6833 pr " if (tok != NULL) {\n";
6834 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6841 pr "guestfs_int_lvm_%s_list *\n" typ;
6842 pr "parse_command_line_%ss (void)\n" typ;
6844 pr " char *out, *err;\n";
6845 pr " char *p, *pend;\n";
6847 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6848 pr " void *newp;\n";
6850 pr " ret = malloc (sizeof *ret);\n";
6851 pr " if (!ret) {\n";
6852 pr " reply_with_perror (\"malloc\");\n";
6853 pr " return NULL;\n";
6856 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6857 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6859 pr " r = command (&out, &err,\n";
6860 pr " \"lvm\", \"%ss\",\n" typ;
6861 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6862 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6863 pr " if (r == -1) {\n";
6864 pr " reply_with_error (\"%%s\", err);\n";
6865 pr " free (out);\n";
6866 pr " free (err);\n";
6867 pr " free (ret);\n";
6868 pr " return NULL;\n";
6871 pr " free (err);\n";
6873 pr " /* Tokenize each line of the output. */\n";
6876 pr " while (p) {\n";
6877 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6878 pr " if (pend) {\n";
6879 pr " *pend = '\\0';\n";
6883 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6886 pr " if (!*p) { /* Empty line? Skip it. */\n";
6891 pr " /* Allocate some space to store this next entry. */\n";
6892 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6893 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6894 pr " if (newp == NULL) {\n";
6895 pr " reply_with_perror (\"realloc\");\n";
6896 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6897 pr " free (ret);\n";
6898 pr " free (out);\n";
6899 pr " return NULL;\n";
6901 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6903 pr " /* Tokenize the next entry. */\n";
6904 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6905 pr " if (r == -1) {\n";
6906 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6907 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6908 pr " free (ret);\n";
6909 pr " free (out);\n";
6910 pr " return NULL;\n";
6917 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6919 pr " free (out);\n";
6920 pr " return ret;\n";
6923 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6925 (* Generate a list of function names, for debugging in the daemon.. *)
6926 and generate_daemon_names () =
6927 generate_header CStyle GPLv2plus;
6929 pr "#include <config.h>\n";
6931 pr "#include \"daemon.h\"\n";
6934 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6935 pr "const char *function_names[] = {\n";
6937 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6941 (* Generate the optional groups for the daemon to implement
6942 * guestfs_available.
6944 and generate_daemon_optgroups_c () =
6945 generate_header CStyle GPLv2plus;
6947 pr "#include <config.h>\n";
6949 pr "#include \"daemon.h\"\n";
6950 pr "#include \"optgroups.h\"\n";
6953 pr "struct optgroup optgroups[] = {\n";
6956 pr " { \"%s\", optgroup_%s_available },\n" group group
6958 pr " { NULL, NULL }\n";
6961 and generate_daemon_optgroups_h () =
6962 generate_header CStyle GPLv2plus;
6966 pr "extern int optgroup_%s_available (void);\n" group
6969 (* Generate the tests. *)
6970 and generate_tests () =
6971 generate_header CStyle GPLv2plus;
6978 #include <sys/types.h>
6981 #include \"guestfs.h\"
6982 #include \"guestfs-internal.h\"
6984 static guestfs_h *g;
6985 static int suppress_error = 0;
6987 static void print_error (guestfs_h *g, void *data, const char *msg)
6989 if (!suppress_error)
6990 fprintf (stderr, \"%%s\\n\", msg);
6993 /* FIXME: nearly identical code appears in fish.c */
6994 static void print_strings (char *const *argv)
6998 for (argc = 0; argv[argc] != NULL; ++argc)
6999 printf (\"\\t%%s\\n\", argv[argc]);
7003 static void print_table (char const *const *argv)
7007 for (i = 0; argv[i] != NULL; i += 2)
7008 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
7013 is_available (const char *group)
7015 const char *groups[] = { group, NULL };
7019 r = guestfs_available (g, (char **) groups);
7026 incr (guestfs_h *g, void *iv)
7028 int *i = (int *) iv;
7034 (* Generate a list of commands which are not tested anywhere. *)
7035 pr "static void no_test_warnings (void)\n";
7038 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
7040 fun (_, _, _, _, tests, _, _) ->
7041 let tests = filter_map (
7043 | (_, (Always|If _|Unless _|IfAvailable _), test) -> Some test
7044 | (_, Disabled, _) -> None
7046 let seq = List.concat (List.map seq_of_test tests) in
7047 let cmds_tested = List.map List.hd seq in
7048 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
7052 fun (name, _, _, _, _, _, _) ->
7053 if not (Hashtbl.mem hash name) then
7054 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
7060 (* Generate the actual tests. Note that we generate the tests
7061 * in reverse order, deliberately, so that (in general) the
7062 * newest tests run first. This makes it quicker and easier to
7067 fun (name, _, _, flags, tests, _, _) ->
7068 mapi (generate_one_test name flags) tests
7069 ) (List.rev all_functions) in
7070 let test_names = List.concat test_names in
7071 let nr_tests = List.length test_names in
7074 int main (int argc, char *argv[])
7077 unsigned long int n_failed = 0;
7078 const char *filename;
7080 int nr_tests, test_num = 0;
7082 setbuf (stdout, NULL);
7084 no_test_warnings ();
7086 g = guestfs_create ();
7088 printf (\"guestfs_create FAILED\\n\");
7089 exit (EXIT_FAILURE);
7092 guestfs_set_error_handler (g, print_error, NULL);
7094 guestfs_set_path (g, \"../appliance\");
7096 filename = \"test1.img\";
7097 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7100 exit (EXIT_FAILURE);
7102 if (lseek (fd, %d, SEEK_SET) == -1) {
7106 exit (EXIT_FAILURE);
7108 if (write (fd, &c, 1) == -1) {
7112 exit (EXIT_FAILURE);
7114 if (close (fd) == -1) {
7117 exit (EXIT_FAILURE);
7119 if (guestfs_add_drive (g, filename) == -1) {
7120 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7121 exit (EXIT_FAILURE);
7124 filename = \"test2.img\";
7125 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7128 exit (EXIT_FAILURE);
7130 if (lseek (fd, %d, SEEK_SET) == -1) {
7134 exit (EXIT_FAILURE);
7136 if (write (fd, &c, 1) == -1) {
7140 exit (EXIT_FAILURE);
7142 if (close (fd) == -1) {
7145 exit (EXIT_FAILURE);
7147 if (guestfs_add_drive (g, filename) == -1) {
7148 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7149 exit (EXIT_FAILURE);
7152 filename = \"test3.img\";
7153 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7156 exit (EXIT_FAILURE);
7158 if (lseek (fd, %d, SEEK_SET) == -1) {
7162 exit (EXIT_FAILURE);
7164 if (write (fd, &c, 1) == -1) {
7168 exit (EXIT_FAILURE);
7170 if (close (fd) == -1) {
7173 exit (EXIT_FAILURE);
7175 if (guestfs_add_drive (g, filename) == -1) {
7176 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7177 exit (EXIT_FAILURE);
7180 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
7181 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
7182 exit (EXIT_FAILURE);
7185 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
7188 if (guestfs_launch (g) == -1) {
7189 printf (\"guestfs_launch FAILED\\n\");
7190 exit (EXIT_FAILURE);
7193 /* Cancel previous alarm. */
7198 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
7202 pr " test_num++;\n";
7203 pr " if (guestfs_get_verbose (g))\n";
7204 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
7205 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
7206 pr " if (%s () == -1) {\n" test_name;
7207 pr " printf (\"%s FAILED\\n\");\n" test_name;
7208 pr " n_failed++;\n";
7213 pr " /* Check close callback is called. */
7214 int close_sentinel = 1;
7215 guestfs_set_close_callback (g, incr, &close_sentinel);
7219 if (close_sentinel != 2) {
7220 fprintf (stderr, \"close callback was not called\\n\");
7221 exit (EXIT_FAILURE);
7224 unlink (\"test1.img\");
7225 unlink (\"test2.img\");
7226 unlink (\"test3.img\");
7230 pr " if (n_failed > 0) {\n";
7231 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
7232 pr " exit (EXIT_FAILURE);\n";
7236 pr " exit (EXIT_SUCCESS);\n";
7239 and generate_one_test name flags i (init, prereq, test) =
7240 let test_name = sprintf "test_%s_%d" name i in
7243 static int %s_skip (void)
7247 str = getenv (\"TEST_ONLY\");
7249 return strstr (str, \"%s\") == NULL;
7250 str = getenv (\"SKIP_%s\");
7251 if (str && STREQ (str, \"1\")) return 1;
7252 str = getenv (\"SKIP_TEST_%s\");
7253 if (str && STREQ (str, \"1\")) return 1;
7257 " test_name name (String.uppercase test_name) (String.uppercase name);
7260 | Disabled | Always | IfAvailable _ -> ()
7261 | If code | Unless code ->
7262 pr "static int %s_prereq (void)\n" test_name;
7270 static int %s (void)
7273 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
7277 " test_name test_name test_name;
7279 (* Optional functions should only be tested if the relevant
7280 * support is available in the daemon.
7285 pr " if (!is_available (\"%s\")) {\n" group;
7286 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", \"%s\");\n" test_name group;
7294 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7296 pr " if (! %s_prereq ()) {\n" test_name;
7297 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7301 generate_one_test_body name i test_name init test;
7303 pr " if (%s_prereq ()) {\n" test_name;
7304 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7308 generate_one_test_body name i test_name init test;
7309 | IfAvailable group ->
7310 pr " if (!is_available (\"%s\")) {\n" group;
7311 pr " printf (\" %%s skipped (reason: %%s not available)\\n\", \"%s\", \"%s\");\n" test_name group;
7315 generate_one_test_body name i test_name init test;
7317 generate_one_test_body name i test_name init test
7325 and generate_one_test_body name i test_name init test =
7327 | InitNone (* XXX at some point, InitNone and InitEmpty became
7328 * folded together as the same thing. Really we should
7329 * make InitNone do nothing at all, but the tests may
7330 * need to be checked to make sure this is OK.
7333 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7334 List.iter (generate_test_command_call test_name)
7335 [["blockdev_setrw"; "/dev/sda"];
7339 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7340 List.iter (generate_test_command_call test_name)
7341 [["blockdev_setrw"; "/dev/sda"];
7344 ["part_disk"; "/dev/sda"; "mbr"]]
7346 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7347 List.iter (generate_test_command_call test_name)
7348 [["blockdev_setrw"; "/dev/sda"];
7351 ["part_disk"; "/dev/sda"; "mbr"];
7352 ["mkfs"; "ext2"; "/dev/sda1"];
7353 ["mount_options"; ""; "/dev/sda1"; "/"]]
7354 | InitBasicFSonLVM ->
7355 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7357 List.iter (generate_test_command_call test_name)
7358 [["blockdev_setrw"; "/dev/sda"];
7361 ["part_disk"; "/dev/sda"; "mbr"];
7362 ["pvcreate"; "/dev/sda1"];
7363 ["vgcreate"; "VG"; "/dev/sda1"];
7364 ["lvcreate"; "LV"; "VG"; "8"];
7365 ["mkfs"; "ext2"; "/dev/VG/LV"];
7366 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7368 pr " /* InitISOFS for %s */\n" test_name;
7369 List.iter (generate_test_command_call test_name)
7370 [["blockdev_setrw"; "/dev/sda"];
7373 ["mount_ro"; "/dev/sdd"; "/"]]
7376 let get_seq_last = function
7378 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7381 let seq = List.rev seq in
7382 List.rev (List.tl seq), List.hd seq
7387 pr " /* TestRun for %s (%d) */\n" name i;
7388 List.iter (generate_test_command_call test_name) seq
7389 | TestOutput (seq, expected) ->
7390 pr " /* TestOutput for %s (%d) */\n" name i;
7391 pr " const char *expected = \"%s\";\n" (c_quote expected);
7392 let seq, last = get_seq_last seq in
7394 pr " if (STRNEQ (r, expected)) {\n";
7395 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7399 List.iter (generate_test_command_call test_name) seq;
7400 generate_test_command_call ~test test_name last
7401 | TestOutputList (seq, expected) ->
7402 pr " /* TestOutputList for %s (%d) */\n" name i;
7403 let seq, last = get_seq_last seq in
7407 pr " if (!r[%d]) {\n" i;
7408 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7409 pr " print_strings (r);\n";
7413 pr " const char *expected = \"%s\";\n" (c_quote str);
7414 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7415 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7420 pr " if (r[%d] != NULL) {\n" (List.length expected);
7421 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7423 pr " print_strings (r);\n";
7427 List.iter (generate_test_command_call test_name) seq;
7428 generate_test_command_call ~test test_name last
7429 | TestOutputListOfDevices (seq, expected) ->
7430 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7431 let seq, last = get_seq_last seq in
7435 pr " if (!r[%d]) {\n" i;
7436 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7437 pr " print_strings (r);\n";
7441 pr " const char *expected = \"%s\";\n" (c_quote str);
7442 pr " r[%d][5] = 's';\n" i;
7443 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7444 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7449 pr " if (r[%d] != NULL) {\n" (List.length expected);
7450 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7452 pr " print_strings (r);\n";
7456 List.iter (generate_test_command_call test_name) seq;
7457 generate_test_command_call ~test test_name last
7458 | TestOutputInt (seq, expected) ->
7459 pr " /* TestOutputInt for %s (%d) */\n" name i;
7460 let seq, last = get_seq_last seq in
7462 pr " if (r != %d) {\n" expected;
7463 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7469 List.iter (generate_test_command_call test_name) seq;
7470 generate_test_command_call ~test test_name last
7471 | TestOutputIntOp (seq, op, expected) ->
7472 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7473 let seq, last = get_seq_last seq in
7475 pr " if (! (r %s %d)) {\n" op expected;
7476 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7477 test_name op expected;
7482 List.iter (generate_test_command_call test_name) seq;
7483 generate_test_command_call ~test test_name last
7484 | TestOutputTrue seq ->
7485 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7486 let seq, last = get_seq_last seq in
7489 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7494 List.iter (generate_test_command_call test_name) seq;
7495 generate_test_command_call ~test test_name last
7496 | TestOutputFalse seq ->
7497 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7498 let seq, last = get_seq_last seq in
7501 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7506 List.iter (generate_test_command_call test_name) seq;
7507 generate_test_command_call ~test test_name last
7508 | TestOutputLength (seq, expected) ->
7509 pr " /* TestOutputLength for %s (%d) */\n" name i;
7510 let seq, last = get_seq_last seq in
7513 pr " for (j = 0; j < %d; ++j)\n" expected;
7514 pr " if (r[j] == NULL) {\n";
7515 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7517 pr " print_strings (r);\n";
7520 pr " if (r[j] != NULL) {\n";
7521 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7523 pr " print_strings (r);\n";
7527 List.iter (generate_test_command_call test_name) seq;
7528 generate_test_command_call ~test test_name last
7529 | TestOutputBuffer (seq, expected) ->
7530 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7531 pr " const char *expected = \"%s\";\n" (c_quote expected);
7532 let seq, last = get_seq_last seq in
7533 let len = String.length expected in
7535 pr " if (size != %d) {\n" len;
7536 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7539 pr " if (STRNEQLEN (r, expected, size)) {\n";
7540 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7544 List.iter (generate_test_command_call test_name) seq;
7545 generate_test_command_call ~test test_name last
7546 | TestOutputStruct (seq, checks) ->
7547 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7548 let seq, last = get_seq_last seq in
7552 | CompareWithInt (field, expected) ->
7553 pr " if (r->%s != %d) {\n" field expected;
7554 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7555 test_name field expected;
7556 pr " (int) r->%s);\n" field;
7559 | CompareWithIntOp (field, op, expected) ->
7560 pr " if (!(r->%s %s %d)) {\n" field op expected;
7561 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7562 test_name field op expected;
7563 pr " (int) r->%s);\n" field;
7566 | CompareWithString (field, expected) ->
7567 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7568 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7569 test_name field expected;
7570 pr " r->%s);\n" field;
7573 | CompareFieldsIntEq (field1, field2) ->
7574 pr " if (r->%s != r->%s) {\n" field1 field2;
7575 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7576 test_name field1 field2;
7577 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7580 | CompareFieldsStrEq (field1, field2) ->
7581 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7582 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7583 test_name field1 field2;
7584 pr " r->%s, r->%s);\n" field1 field2;
7589 List.iter (generate_test_command_call test_name) seq;
7590 generate_test_command_call ~test test_name last
7591 | TestLastFail seq ->
7592 pr " /* TestLastFail for %s (%d) */\n" name i;
7593 let seq, last = get_seq_last seq in
7594 List.iter (generate_test_command_call test_name) seq;
7595 generate_test_command_call test_name ~expect_error:true last
7597 (* Generate the code to run a command, leaving the result in 'r'.
7598 * If you expect to get an error then you should set expect_error:true.
7600 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7602 | [] -> assert false
7604 (* Look up the command to find out what args/ret it has. *)
7607 let _, style, _, _, _, _, _ =
7608 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7611 failwithf "%s: in test, command %s was not found" test_name name in
7613 if List.length (snd style) <> List.length args then
7614 failwithf "%s: in test, wrong number of args given to %s"
7621 | OptString n, "NULL" -> ()
7624 | Dev_or_Path n, arg
7628 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7629 | BufferIn n, arg ->
7630 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7631 pr " size_t %s_size = %d;\n" n (String.length arg)
7635 | FileIn _, _ | FileOut _, _ -> ()
7636 | StringList n, "" | DeviceList n, "" ->
7637 pr " const char *const %s[1] = { NULL };\n" n
7638 | StringList n, arg | DeviceList n, arg ->
7639 let strs = string_split " " arg in
7642 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7644 pr " const char *const %s[] = {\n" n;
7646 fun i _ -> pr " %s_%d,\n" n i
7650 ) (List.combine (snd style) args);
7653 match fst style with
7654 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7655 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7656 | RConstString _ | RConstOptString _ ->
7657 pr " const char *r;\n"; "NULL"
7658 | RString _ -> pr " char *r;\n"; "NULL"
7659 | RStringList _ | RHashtable _ ->
7663 | RStruct (_, typ) ->
7664 pr " struct guestfs_%s *r;\n" typ; "NULL"
7665 | RStructList (_, typ) ->
7666 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7669 pr " size_t size;\n";
7672 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7673 pr " r = guestfs_%s (g" name;
7675 (* Generate the parameters. *)
7678 | OptString _, "NULL" -> pr ", NULL"
7680 | Device n, _ | Dev_or_Path n, _
7686 pr ", %s, %s_size" n n
7687 | FileIn _, arg | FileOut _, arg ->
7688 pr ", \"%s\"" (c_quote arg)
7689 | StringList n, _ | DeviceList n, _ ->
7690 pr ", (char **) %s" n
7693 try int_of_string arg
7694 with Failure "int_of_string" ->
7695 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7699 try Int64.of_string arg
7700 with Failure "int_of_string" ->
7701 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7704 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7705 ) (List.combine (snd style) args);
7707 (match fst style with
7708 | RBufferOut _ -> pr ", &size"
7714 if not expect_error then
7715 pr " if (r == %s)\n" error_code
7717 pr " if (r != %s)\n" error_code;
7720 (* Insert the test code. *)
7726 (match fst style with
7727 | RErr | RInt _ | RInt64 _ | RBool _
7728 | RConstString _ | RConstOptString _ -> ()
7729 | RString _ | RBufferOut _ -> pr " free (r);\n"
7730 | RStringList _ | RHashtable _ ->
7731 pr " for (i = 0; r[i] != NULL; ++i)\n";
7732 pr " free (r[i]);\n";
7734 | RStruct (_, typ) ->
7735 pr " guestfs_free_%s (r);\n" typ
7736 | RStructList (_, typ) ->
7737 pr " guestfs_free_%s_list (r);\n" typ
7743 let str = replace_str str "\r" "\\r" in
7744 let str = replace_str str "\n" "\\n" in
7745 let str = replace_str str "\t" "\\t" in
7746 let str = replace_str str "\000" "\\0" in
7749 (* Generate a lot of different functions for guestfish. *)
7750 and generate_fish_cmds () =
7751 generate_header CStyle GPLv2plus;
7755 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7757 let all_functions_sorted =
7759 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7760 ) all_functions_sorted in
7762 pr "#include <config.h>\n";
7764 pr "#include <stdio.h>\n";
7765 pr "#include <stdlib.h>\n";
7766 pr "#include <string.h>\n";
7767 pr "#include <inttypes.h>\n";
7769 pr "#include <guestfs.h>\n";
7770 pr "#include \"c-ctype.h\"\n";
7771 pr "#include \"full-write.h\"\n";
7772 pr "#include \"xstrtol.h\"\n";
7773 pr "#include \"fish.h\"\n";
7775 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7776 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7779 (* list_commands function, which implements guestfish -h *)
7780 pr "void list_commands (void)\n";
7782 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7783 pr " list_builtin_commands ();\n";
7785 fun (name, _, _, flags, _, shortdesc, _) ->
7786 let name = replace_char name '_' '-' in
7787 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7789 ) all_functions_sorted;
7790 pr " printf (\" %%s\\n\",";
7791 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7795 (* display_command function, which implements guestfish -h cmd *)
7796 pr "int display_command (const char *cmd)\n";
7799 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7800 let name2 = replace_char name '_' '-' in
7802 try find_map (function FishAlias n -> Some n | _ -> None) flags
7803 with Not_found -> name in
7804 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7806 match snd style with
7809 let args = List.filter (function Key _ -> false | _ -> true) args in
7811 name2 (String.concat " " (List.map name_of_argt args)) in
7814 if List.exists (function Key _ -> true | _ -> false) (snd style) then
7815 "\n\nThis command has one or more key or passphrase parameters.
7816 Guestfish will prompt for these separately."
7821 if List.mem ProtocolLimitWarning flags then
7822 ("\n\n" ^ protocol_limit_warning)
7825 (* For DangerWillRobinson commands, we should probably have
7826 * guestfish prompt before allowing you to use them (especially
7827 * in interactive mode). XXX
7831 if List.mem DangerWillRobinson flags then
7832 ("\n\n" ^ danger_will_robinson)
7837 match deprecation_notice flags with
7839 | Some txt -> "\n\n" ^ txt in
7841 let describe_alias =
7842 if name <> alias then
7843 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7847 pr "STRCASEEQ (cmd, \"%s\")" name;
7848 if name <> name2 then
7849 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7850 if name <> alias then
7851 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7853 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7855 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7856 "=head1 DESCRIPTION\n\n" ^
7857 longdesc ^ warnings ^ describe_alias);
7862 pr " return display_builtin_command (cmd);\n";
7866 let emit_print_list_function typ =
7867 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7870 pr " unsigned int i;\n";
7872 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7873 pr " printf (\"[%%d] = {\\n\", i);\n";
7874 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7875 pr " printf (\"}\\n\");\n";
7881 (* print_* functions *)
7885 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7887 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7890 pr " unsigned int i;\n";
7896 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7898 pr " printf (\"%%s%s: \", indent);\n" name;
7899 pr " for (i = 0; i < 32; ++i)\n";
7900 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7901 pr " printf (\"\\n\");\n"
7903 pr " printf (\"%%s%s: \", indent);\n" name;
7904 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7905 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7906 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7908 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7909 pr " printf (\"\\n\");\n"
7910 | name, (FUInt64|FBytes) ->
7911 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7914 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7917 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7920 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7923 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7925 | name, FOptPercent ->
7926 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7927 typ name name typ name;
7928 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7934 (* Emit a print_TYPE_list function definition only if that function is used. *)
7937 | typ, (RStructListOnly | RStructAndList) ->
7938 (* generate the function for typ *)
7939 emit_print_list_function typ
7940 | typ, _ -> () (* empty *)
7941 ) (rstructs_used_by all_functions);
7943 (* Emit a print_TYPE function definition only if that function is used. *)
7946 | typ, (RStructOnly | RStructAndList) ->
7947 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7949 pr " print_%s_indent (%s, \"\");\n" typ typ;
7952 | typ, _ -> () (* empty *)
7953 ) (rstructs_used_by all_functions);
7955 (* run_<action> actions *)
7957 fun (name, style, _, flags, _, _, _) ->
7958 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7960 (match fst style with
7963 | RBool _ -> pr " int r;\n"
7964 | RInt64 _ -> pr " int64_t r;\n"
7965 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7966 | RString _ -> pr " char *r;\n"
7967 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7968 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7969 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7972 pr " size_t size;\n";
7978 | OptString n -> pr " const char *%s;\n" n
7983 | Key n -> pr " char *%s;\n" n
7985 pr " const char *%s;\n" n;
7986 pr " size_t %s_size;\n" n
7987 | StringList n | DeviceList n -> pr " char **%s;\n" n
7988 | Bool n -> pr " int %s;\n" n
7989 | Int n -> pr " int %s;\n" n
7990 | Int64 n -> pr " int64_t %s;\n" n
7993 (* Check and convert parameters. *)
7996 List.filter (function Key _ -> false | _ -> true) (snd style) in
7997 List.length args_no_keys in
7998 pr " if (argc != %d) {\n" argc_expected;
7999 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
8001 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
8005 let parse_integer fn fntyp rtyp range name =
8007 pr " strtol_error xerr;\n";
8008 pr " %s r;\n" fntyp;
8010 pr " xerr = %s (argv[i++], NULL, 0, &r, xstrtol_suffixes);\n" fn;
8011 pr " if (xerr != LONGINT_OK) {\n";
8012 pr " fprintf (stderr,\n";
8013 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
8014 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
8019 | Some (min, max, comment) ->
8020 pr " /* %s */\n" comment;
8021 pr " if (r < %s || r > %s) {\n" min max;
8022 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
8026 pr " /* The check above should ensure this assignment does not overflow. */\n";
8028 pr " %s = r;\n" name;
8032 if snd style <> [] then
8033 pr " size_t i = 0;\n";
8039 pr " %s = argv[i++];\n" name
8041 | Dev_or_Path name ->
8042 pr " %s = resolve_win_path (argv[i++]);\n" name;
8043 pr " if (%s == NULL) return -1;\n" name
8045 pr " %s = STRNEQ (argv[i], \"\") ? argv[i] : NULL;\n" name;
8048 pr " %s = argv[i];\n" name;
8049 pr " %s_size = strlen (argv[i]);\n" name;
8052 pr " %s = file_in (argv[i++]);\n" name;
8053 pr " if (%s == NULL) return -1;\n" name
8055 pr " %s = file_out (argv[i++]);\n" name;
8056 pr " if (%s == NULL) return -1;\n" name
8057 | StringList name | DeviceList name ->
8058 pr " %s = parse_string_list (argv[i++]);\n" name;
8059 pr " if (%s == NULL) return -1;\n" name
8061 pr " %s = read_key (\"%s\");\n" name name;
8062 pr " if (%s == NULL) return -1;\n" name
8064 pr " %s = is_true (argv[i++]) ? 1 : 0;\n" name
8067 let min = "(-(2LL<<30))"
8068 and max = "((2LL<<30)-1)"
8070 "The Int type in the generator is a signed 31 bit int." in
8071 Some (min, max, comment) in
8072 parse_integer "xstrtoll" "long long" "int" range name
8074 parse_integer "xstrtoll" "long long" "int64_t" None name
8077 (* Call C API function. *)
8078 pr " r = guestfs_%s " name;
8079 generate_c_call_args ~handle:"g" style;
8084 | Device _ | String _
8085 | OptString _ | Bool _
8088 | Pathname name | Dev_or_Path name | FileOut name
8090 pr " free (%s);\n" name
8092 pr " free_file_in (%s);\n" name
8093 | StringList name | DeviceList name ->
8094 pr " free_strings (%s);\n" name
8097 (* Any output flags? *)
8099 let flags = filter_map (
8100 function FishOutput flag -> Some flag | _ -> None
8106 failwithf "%s: more than one FishOutput flag is not allowed" name in
8108 (* Check return value for errors and display command results. *)
8109 (match fst style with
8110 | RErr -> pr " return r;\n"
8112 pr " if (r == -1) return -1;\n";
8113 (match fish_output with
8115 pr " printf (\"%%d\\n\", r);\n";
8116 | Some FishOutputOctal ->
8117 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
8118 | Some FishOutputHexadecimal ->
8119 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
8122 pr " if (r == -1) return -1;\n";
8123 (match fish_output with
8125 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
8126 | Some FishOutputOctal ->
8127 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
8128 | Some FishOutputHexadecimal ->
8129 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
8132 pr " if (r == -1) return -1;\n";
8133 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
8136 pr " if (r == NULL) return -1;\n";
8137 pr " printf (\"%%s\\n\", r);\n";
8139 | RConstOptString _ ->
8140 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
8143 pr " if (r == NULL) return -1;\n";
8144 pr " printf (\"%%s\\n\", r);\n";
8148 pr " if (r == NULL) return -1;\n";
8149 pr " print_strings (r);\n";
8150 pr " free_strings (r);\n";
8152 | RStruct (_, typ) ->
8153 pr " if (r == NULL) return -1;\n";
8154 pr " print_%s (r);\n" typ;
8155 pr " guestfs_free_%s (r);\n" typ;
8157 | RStructList (_, typ) ->
8158 pr " if (r == NULL) return -1;\n";
8159 pr " print_%s_list (r);\n" typ;
8160 pr " guestfs_free_%s_list (r);\n" typ;
8163 pr " if (r == NULL) return -1;\n";
8164 pr " print_table (r);\n";
8165 pr " free_strings (r);\n";
8168 pr " if (r == NULL) return -1;\n";
8169 pr " if (full_write (1, r, size) != size) {\n";
8170 pr " perror (\"write\");\n";
8181 (* run_action function *)
8182 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
8185 fun (name, _, _, flags, _, _, _) ->
8186 let name2 = replace_char name '_' '-' in
8188 try find_map (function FishAlias n -> Some n | _ -> None) flags
8189 with Not_found -> name in
8191 pr "STRCASEEQ (cmd, \"%s\")" name;
8192 if name <> name2 then
8193 pr " || STRCASEEQ (cmd, \"%s\")" name2;
8194 if name <> alias then
8195 pr " || STRCASEEQ (cmd, \"%s\")" alias;
8197 pr " return run_%s (cmd, argc, argv);\n" name;
8201 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
8202 pr " if (command_num == 1)\n";
8203 pr " extended_help_message ();\n";
8210 (* Readline completion for guestfish. *)
8211 and generate_fish_completion () =
8212 generate_header CStyle GPLv2plus;
8216 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8226 #ifdef HAVE_LIBREADLINE
8227 #include <readline/readline.h>
8232 #ifdef HAVE_LIBREADLINE
8234 static const char *const commands[] = {
8235 BUILTIN_COMMANDS_FOR_COMPLETION,
8238 (* Get the commands, including the aliases. They don't need to be
8239 * sorted - the generator() function just does a dumb linear search.
8243 fun (name, _, _, flags, _, _, _) ->
8244 let name2 = replace_char name '_' '-' in
8246 try find_map (function FishAlias n -> Some n | _ -> None) flags
8247 with Not_found -> name in
8249 if name <> alias then [name2; alias] else [name2]
8251 let commands = List.flatten commands in
8253 List.iter (pr " \"%s\",\n") commands;
8259 generator (const char *text, int state)
8261 static size_t index, len;
8266 len = strlen (text);
8269 rl_attempted_completion_over = 1;
8271 while ((name = commands[index]) != NULL) {
8273 if (STRCASEEQLEN (name, text, len))
8274 return strdup (name);
8280 #endif /* HAVE_LIBREADLINE */
8282 #ifdef HAVE_RL_COMPLETION_MATCHES
8283 #define RL_COMPLETION_MATCHES rl_completion_matches
8285 #ifdef HAVE_COMPLETION_MATCHES
8286 #define RL_COMPLETION_MATCHES completion_matches
8288 #endif /* else just fail if we don't have either symbol */
8291 do_completion (const char *text, int start, int end)
8293 char **matches = NULL;
8295 #ifdef HAVE_LIBREADLINE
8296 rl_completion_append_character = ' ';
8299 matches = RL_COMPLETION_MATCHES (text, generator);
8300 else if (complete_dest_paths)
8301 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
8308 (* Generate the POD documentation for guestfish. *)
8309 and generate_fish_actions_pod () =
8310 let all_functions_sorted =
8312 fun (_, _, _, flags, _, _, _) ->
8313 not (List.mem NotInFish flags || List.mem NotInDocs flags)
8314 ) all_functions_sorted in
8316 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8319 fun (name, style, _, flags, _, _, longdesc) ->
8321 Str.global_substitute rex (
8324 try Str.matched_group 1 s
8326 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8327 "C<" ^ replace_char sub '_' '-' ^ ">"
8329 let name = replace_char name '_' '-' in
8331 try find_map (function FishAlias n -> Some n | _ -> None) flags
8332 with Not_found -> name in
8334 pr "=head2 %s" name;
8335 if name <> alias then
8342 | Pathname n | Device n | Dev_or_Path n | String n ->
8344 | OptString n -> pr " %s" n
8345 | StringList n | DeviceList n -> pr " '%s ...'" n
8346 | Bool _ -> pr " true|false"
8347 | Int n -> pr " %s" n
8348 | Int64 n -> pr " %s" n
8349 | FileIn n | FileOut n -> pr " (%s|-)" n
8350 | BufferIn n -> pr " %s" n
8351 | Key _ -> () (* keys are entered at a prompt *)
8355 pr "%s\n\n" longdesc;
8357 if List.exists (function FileIn _ | FileOut _ -> true
8358 | _ -> false) (snd style) then
8359 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8361 if List.exists (function Key _ -> true | _ -> false) (snd style) then
8362 pr "This command has one or more key or passphrase parameters.
8363 Guestfish will prompt for these separately.\n\n";
8365 if List.mem ProtocolLimitWarning flags then
8366 pr "%s\n\n" protocol_limit_warning;
8368 if List.mem DangerWillRobinson flags then
8369 pr "%s\n\n" danger_will_robinson;
8371 match deprecation_notice flags with
8373 | Some txt -> pr "%s\n\n" txt
8374 ) all_functions_sorted
8376 (* Generate a C function prototype. *)
8377 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8378 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8380 ?handle name style =
8381 if extern then pr "extern ";
8382 if static then pr "static ";
8383 (match fst style with
8385 | RInt _ -> pr "int "
8386 | RInt64 _ -> pr "int64_t "
8387 | RBool _ -> pr "int "
8388 | RConstString _ | RConstOptString _ -> pr "const char *"
8389 | RString _ | RBufferOut _ -> pr "char *"
8390 | RStringList _ | RHashtable _ -> pr "char **"
8391 | RStruct (_, typ) ->
8392 if not in_daemon then pr "struct guestfs_%s *" typ
8393 else pr "guestfs_int_%s *" typ
8394 | RStructList (_, typ) ->
8395 if not in_daemon then pr "struct guestfs_%s_list *" typ
8396 else pr "guestfs_int_%s_list *" typ
8398 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8399 pr "%s%s (" prefix name;
8400 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8403 let comma = ref false in
8406 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8410 if single_line then pr ", " else pr ",\n\t\t"
8417 | Device n | Dev_or_Path n
8422 pr "const char *%s" n
8423 | StringList n | DeviceList n ->
8425 pr "char *const *%s" n
8426 | Bool n -> next (); pr "int %s" n
8427 | Int n -> next (); pr "int %s" n
8428 | Int64 n -> next (); pr "int64_t %s" n
8431 if not in_daemon then (next (); pr "const char *%s" n)
8434 pr "const char *%s" n;
8436 pr "size_t %s_size" n
8438 if is_RBufferOut then (next (); pr "size_t *size_r");
8441 if semicolon then pr ";";
8442 if newline then pr "\n"
8444 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8445 and generate_c_call_args ?handle ?(decl = false) style =
8447 let comma = ref false in
8449 if !comma then pr ", ";
8454 | Some handle -> pr "%s" handle; comma := true
8460 pr "%s, %s_size" n n
8463 pr "%s" (name_of_argt arg)
8465 (* For RBufferOut calls, add implicit &size parameter. *)
8467 match fst style with
8475 (* Generate the OCaml bindings interface. *)
8476 and generate_ocaml_mli () =
8477 generate_header OCamlStyle LGPLv2plus;
8480 (** For API documentation you should refer to the C API
8481 in the guestfs(3) manual page. The OCaml API uses almost
8482 exactly the same calls. *)
8485 (** A [guestfs_h] handle. *)
8487 exception Error of string
8488 (** This exception is raised when there is an error. *)
8490 exception Handle_closed of string
8491 (** This exception is raised if you use a {!Guestfs.t} handle
8492 after calling {!close} on it. The string is the name of
8495 val create : unit -> t
8496 (** Create a {!Guestfs.t} handle. *)
8498 val close : t -> unit
8499 (** Close the {!Guestfs.t} handle and free up all resources used
8502 Handles are closed by the garbage collector when they become
8503 unreferenced, but callers can call this in order to provide
8504 predictable cleanup. *)
8507 generate_ocaml_structure_decls ();
8511 fun (name, style, _, _, _, shortdesc, _) ->
8512 generate_ocaml_prototype name style;
8513 pr "(** %s *)\n" shortdesc;
8515 ) all_functions_sorted
8517 (* Generate the OCaml bindings implementation. *)
8518 and generate_ocaml_ml () =
8519 generate_header OCamlStyle LGPLv2plus;
8524 exception Error of string
8525 exception Handle_closed of string
8527 external create : unit -> t = \"ocaml_guestfs_create\"
8528 external close : t -> unit = \"ocaml_guestfs_close\"
8530 (* Give the exceptions names, so they can be raised from the C code. *)
8532 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8533 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8537 generate_ocaml_structure_decls ();
8541 fun (name, style, _, _, _, shortdesc, _) ->
8542 generate_ocaml_prototype ~is_external:true name style;
8543 ) all_functions_sorted
8545 (* Generate the OCaml bindings C implementation. *)
8546 and generate_ocaml_c () =
8547 generate_header CStyle LGPLv2plus;
8554 #include <caml/config.h>
8555 #include <caml/alloc.h>
8556 #include <caml/callback.h>
8557 #include <caml/fail.h>
8558 #include <caml/memory.h>
8559 #include <caml/mlvalues.h>
8560 #include <caml/signals.h>
8562 #include \"guestfs.h\"
8564 #include \"guestfs_c.h\"
8566 /* Copy a hashtable of string pairs into an assoc-list. We return
8567 * the list in reverse order, but hashtables aren't supposed to be
8570 static CAMLprim value
8571 copy_table (char * const * argv)
8574 CAMLlocal5 (rv, pairv, kv, vv, cons);
8578 for (i = 0; argv[i] != NULL; i += 2) {
8579 kv = caml_copy_string (argv[i]);
8580 vv = caml_copy_string (argv[i+1]);
8581 pairv = caml_alloc (2, 0);
8582 Store_field (pairv, 0, kv);
8583 Store_field (pairv, 1, vv);
8584 cons = caml_alloc (2, 0);
8585 Store_field (cons, 1, rv);
8587 Store_field (cons, 0, pairv);
8595 (* Struct copy functions. *)
8597 let emit_ocaml_copy_list_function typ =
8598 pr "static CAMLprim value\n";
8599 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8601 pr " CAMLparam0 ();\n";
8602 pr " CAMLlocal2 (rv, v);\n";
8603 pr " unsigned int i;\n";
8605 pr " if (%ss->len == 0)\n" typ;
8606 pr " CAMLreturn (Atom (0));\n";
8608 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8609 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8610 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8611 pr " caml_modify (&Field (rv, i), v);\n";
8613 pr " CAMLreturn (rv);\n";
8621 let has_optpercent_col =
8622 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8624 pr "static CAMLprim value\n";
8625 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8627 pr " CAMLparam0 ();\n";
8628 if has_optpercent_col then
8629 pr " CAMLlocal3 (rv, v, v2);\n"
8631 pr " CAMLlocal2 (rv, v);\n";
8633 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8638 pr " v = caml_copy_string (%s->%s);\n" typ name
8640 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8641 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8644 pr " v = caml_alloc_string (32);\n";
8645 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8646 | name, (FBytes|FInt64|FUInt64) ->
8647 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8648 | name, (FInt32|FUInt32) ->
8649 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8650 | name, FOptPercent ->
8651 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8652 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8653 pr " v = caml_alloc (1, 0);\n";
8654 pr " Store_field (v, 0, v2);\n";
8655 pr " } else /* None */\n";
8656 pr " v = Val_int (0);\n";
8658 pr " v = Val_int (%s->%s);\n" typ name
8660 pr " Store_field (rv, %d, v);\n" i
8662 pr " CAMLreturn (rv);\n";
8667 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8670 | typ, (RStructListOnly | RStructAndList) ->
8671 (* generate the function for typ *)
8672 emit_ocaml_copy_list_function typ
8673 | typ, _ -> () (* empty *)
8674 ) (rstructs_used_by all_functions);
8678 fun (name, style, _, _, _, _, _) ->
8679 pr "/* Automatically generated wrapper for function\n";
8681 generate_ocaml_prototype name style;
8686 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8688 let needs_extra_vs =
8689 match fst style with RConstOptString _ -> true | _ -> false in
8691 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8692 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8693 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8696 pr "CAMLprim value\n";
8697 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8698 List.iter (pr ", value %s") (List.tl params);
8703 | [p1; p2; p3; p4; p5] ->
8704 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8705 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8706 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8707 pr " CAMLxparam%d (%s);\n"
8708 (List.length rest) (String.concat ", " rest)
8710 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8712 if not needs_extra_vs then
8713 pr " CAMLlocal1 (rv);\n"
8715 pr " CAMLlocal3 (rv, v, v2);\n";
8718 pr " guestfs_h *g = Guestfs_val (gv);\n";
8719 pr " if (g == NULL)\n";
8720 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8726 | Device n | Dev_or_Path n
8731 (* Copy strings in case the GC moves them: RHBZ#604691 *)
8732 pr " char *%s = guestfs_safe_strdup (g, String_val (%sv));\n" n n
8734 pr " char *%s =\n" n;
8735 pr " %sv != Val_int (0) ?" n;
8736 pr " guestfs_safe_strdup (g, String_val (Field (%sv, 0))) : NULL;\n" n
8738 pr " size_t %s_size = caml_string_length (%sv);\n" n n;
8739 pr " char *%s = guestfs_safe_memdup (g, String_val (%sv), %s_size);\n" n n n
8740 | StringList n | DeviceList n ->
8741 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8743 pr " int %s = Bool_val (%sv);\n" n n
8745 pr " int %s = Int_val (%sv);\n" n n
8747 pr " int64_t %s = Int64_val (%sv);\n" n n
8750 match fst style with
8751 | RErr -> pr " int r;\n"; "-1"
8752 | RInt _ -> pr " int r;\n"; "-1"
8753 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8754 | RBool _ -> pr " int r;\n"; "-1"
8755 | RConstString _ | RConstOptString _ ->
8756 pr " const char *r;\n"; "NULL"
8757 | RString _ -> pr " char *r;\n"; "NULL"
8762 | RStruct (_, typ) ->
8763 pr " struct guestfs_%s *r;\n" typ; "NULL"
8764 | RStructList (_, typ) ->
8765 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8772 pr " size_t size;\n";
8776 pr " caml_enter_blocking_section ();\n";
8777 pr " r = guestfs_%s " name;
8778 generate_c_call_args ~handle:"g" style;
8780 pr " caml_leave_blocking_section ();\n";
8782 (* Free strings if we copied them above. *)
8785 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
8786 | FileIn n | FileOut n | BufferIn n | Key n ->
8787 pr " free (%s);\n" n
8788 | StringList n | DeviceList n ->
8789 pr " ocaml_guestfs_free_strings (%s);\n" n;
8790 | Bool _ | Int _ | Int64 _ -> ()
8793 pr " if (r == %s)\n" error_code;
8794 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8797 (match fst style with
8798 | RErr -> pr " rv = Val_unit;\n"
8799 | RInt _ -> pr " rv = Val_int (r);\n"
8801 pr " rv = caml_copy_int64 (r);\n"
8802 | RBool _ -> pr " rv = Val_bool (r);\n"
8804 pr " rv = caml_copy_string (r);\n"
8805 | RConstOptString _ ->
8806 pr " if (r) { /* Some string */\n";
8807 pr " v = caml_alloc (1, 0);\n";
8808 pr " v2 = caml_copy_string (r);\n";
8809 pr " Store_field (v, 0, v2);\n";
8810 pr " } else /* None */\n";
8811 pr " v = Val_int (0);\n";
8813 pr " rv = caml_copy_string (r);\n";
8816 pr " rv = caml_copy_string_array ((const char **) r);\n";
8817 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8819 | RStruct (_, typ) ->
8820 pr " rv = copy_%s (r);\n" typ;
8821 pr " guestfs_free_%s (r);\n" typ;
8822 | RStructList (_, typ) ->
8823 pr " rv = copy_%s_list (r);\n" typ;
8824 pr " guestfs_free_%s_list (r);\n" typ;
8826 pr " rv = copy_table (r);\n";
8827 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8830 pr " rv = caml_alloc_string (size);\n";
8831 pr " memcpy (String_val (rv), r, size);\n";
8834 pr " CAMLreturn (rv);\n";
8838 if List.length params > 5 then (
8839 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8840 pr "CAMLprim value ";
8841 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8842 pr "CAMLprim value\n";
8843 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8845 pr " return ocaml_guestfs_%s (argv[0]" name;
8846 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8851 ) all_functions_sorted
8853 and generate_ocaml_structure_decls () =
8856 pr "type %s = {\n" typ;
8859 | name, FString -> pr " %s : string;\n" name
8860 | name, FBuffer -> pr " %s : string;\n" name
8861 | name, FUUID -> pr " %s : string;\n" name
8862 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8863 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8864 | name, FChar -> pr " %s : char;\n" name
8865 | name, FOptPercent -> pr " %s : float option;\n" name
8871 and generate_ocaml_prototype ?(is_external = false) name style =
8872 if is_external then pr "external " else pr "val ";
8873 pr "%s : t -> " name;
8876 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8877 | BufferIn _ | Key _ -> pr "string -> "
8878 | OptString _ -> pr "string option -> "
8879 | StringList _ | DeviceList _ -> pr "string array -> "
8880 | Bool _ -> pr "bool -> "
8881 | Int _ -> pr "int -> "
8882 | Int64 _ -> pr "int64 -> "
8884 (match fst style with
8885 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8886 | RInt _ -> pr "int"
8887 | RInt64 _ -> pr "int64"
8888 | RBool _ -> pr "bool"
8889 | RConstString _ -> pr "string"
8890 | RConstOptString _ -> pr "string option"
8891 | RString _ | RBufferOut _ -> pr "string"
8892 | RStringList _ -> pr "string array"
8893 | RStruct (_, typ) -> pr "%s" typ
8894 | RStructList (_, typ) -> pr "%s array" typ
8895 | RHashtable _ -> pr "(string * string) list"
8897 if is_external then (
8899 if List.length (snd style) + 1 > 5 then
8900 pr "\"ocaml_guestfs_%s_byte\" " name;
8901 pr "\"ocaml_guestfs_%s\"" name
8905 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8906 and generate_perl_xs () =
8907 generate_header CStyle LGPLv2plus;
8910 #include \"EXTERN.h\"
8914 #include <guestfs.h>
8917 #define PRId64 \"lld\"
8921 my_newSVll(long long val) {
8922 #ifdef USE_64_BIT_ALL
8923 return newSViv(val);
8927 len = snprintf(buf, 100, \"%%\" PRId64, val);
8928 return newSVpv(buf, len);
8933 #define PRIu64 \"llu\"
8937 my_newSVull(unsigned long long val) {
8938 #ifdef USE_64_BIT_ALL
8939 return newSVuv(val);
8943 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8944 return newSVpv(buf, len);
8948 /* http://www.perlmonks.org/?node_id=680842 */
8950 XS_unpack_charPtrPtr (SV *arg) {
8955 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8956 croak (\"array reference expected\");
8958 av = (AV *)SvRV (arg);
8959 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8961 croak (\"malloc failed\");
8963 for (i = 0; i <= av_len (av); i++) {
8964 SV **elem = av_fetch (av, i, 0);
8966 if (!elem || !*elem)
8967 croak (\"missing element in list\");
8969 ret[i] = SvPV_nolen (*elem);
8977 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8984 RETVAL = guestfs_create ();
8986 croak (\"could not create guestfs handle\");
8987 guestfs_set_error_handler (RETVAL, NULL, NULL);
8995 /* For the 'g' argument above we do the conversion explicitly and
8996 * don't rely on the typemap, because if the handle has been
8997 * explicitly closed we don't want the typemap conversion to
9000 HV *hv = (HV *) SvRV (sv);
9001 SV **svp = hv_fetch (hv, \"_g\", 2, 0);
9003 guestfs_h *g = (guestfs_h *) SvIV (*svp);
9013 /* Avoid double-free in DESTROY method. */
9014 HV *hv = (HV *) SvRV (ST(0));
9015 (void) hv_delete (hv, \"_g\", 2, G_DISCARD);
9020 fun (name, style, _, _, _, _, _) ->
9021 (match fst style with
9022 | RErr -> pr "void\n"
9023 | RInt _ -> pr "SV *\n"
9024 | RInt64 _ -> pr "SV *\n"
9025 | RBool _ -> pr "SV *\n"
9026 | RConstString _ -> pr "SV *\n"
9027 | RConstOptString _ -> pr "SV *\n"
9028 | RString _ -> pr "SV *\n"
9029 | RBufferOut _ -> pr "SV *\n"
9031 | RStruct _ | RStructList _
9033 pr "void\n" (* all lists returned implictly on the stack *)
9035 (* Call and arguments. *)
9038 fun arg -> pr ", %s" (name_of_argt arg)
9041 pr " guestfs_h *g;\n";
9045 | Pathname n | Device n | Dev_or_Path n | String n
9046 | FileIn n | FileOut n | Key n ->
9049 pr " char *%s;\n" n;
9050 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
9052 (* http://www.perlmonks.org/?node_id=554277
9053 * Note that the implicit handle argument means we have
9054 * to add 1 to the ST(x) operator.
9056 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
9057 | StringList n | DeviceList n -> pr " char **%s;\n" n
9058 | Bool n -> pr " int %s;\n" n
9059 | Int n -> pr " int %s;\n" n
9060 | Int64 n -> pr " int64_t %s;\n" n
9063 let do_cleanups () =
9066 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
9067 | Bool _ | Int _ | Int64 _
9068 | FileIn _ | FileOut _
9069 | BufferIn _ | Key _ -> ()
9070 | StringList n | DeviceList n -> pr " free (%s);\n" n
9075 (match fst style with
9080 pr " r = guestfs_%s " name;
9081 generate_c_call_args ~handle:"g" style;
9084 pr " if (r == -1)\n";
9085 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9091 pr " %s = guestfs_%s " n name;
9092 generate_c_call_args ~handle:"g" style;
9095 pr " if (%s == -1)\n" n;
9096 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9097 pr " RETVAL = newSViv (%s);\n" n;
9102 pr " int64_t %s;\n" n;
9104 pr " %s = guestfs_%s " n name;
9105 generate_c_call_args ~handle:"g" style;
9108 pr " if (%s == -1)\n" n;
9109 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9110 pr " RETVAL = my_newSVll (%s);\n" n;
9115 pr " const char *%s;\n" n;
9117 pr " %s = guestfs_%s " n name;
9118 generate_c_call_args ~handle:"g" style;
9121 pr " if (%s == NULL)\n" n;
9122 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9123 pr " RETVAL = newSVpv (%s, 0);\n" n;
9126 | RConstOptString n ->
9128 pr " const char *%s;\n" n;
9130 pr " %s = guestfs_%s " n name;
9131 generate_c_call_args ~handle:"g" style;
9134 pr " if (%s == NULL)\n" n;
9135 pr " RETVAL = &PL_sv_undef;\n";
9137 pr " RETVAL = newSVpv (%s, 0);\n" n;
9142 pr " char *%s;\n" n;
9144 pr " %s = guestfs_%s " n name;
9145 generate_c_call_args ~handle:"g" style;
9148 pr " if (%s == NULL)\n" n;
9149 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9150 pr " RETVAL = newSVpv (%s, 0);\n" n;
9151 pr " free (%s);\n" n;
9154 | RStringList n | RHashtable n ->
9156 pr " char **%s;\n" n;
9157 pr " size_t i, n;\n";
9159 pr " %s = guestfs_%s " n name;
9160 generate_c_call_args ~handle:"g" style;
9163 pr " if (%s == NULL)\n" n;
9164 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9165 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
9166 pr " EXTEND (SP, n);\n";
9167 pr " for (i = 0; i < n; ++i) {\n";
9168 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
9169 pr " free (%s[i]);\n" n;
9171 pr " free (%s);\n" n;
9172 | RStruct (n, typ) ->
9173 let cols = cols_of_struct typ in
9174 generate_perl_struct_code typ cols name style n do_cleanups
9175 | RStructList (n, typ) ->
9176 let cols = cols_of_struct typ in
9177 generate_perl_struct_list_code typ cols name style n do_cleanups
9180 pr " char *%s;\n" n;
9181 pr " size_t size;\n";
9183 pr " %s = guestfs_%s " n name;
9184 generate_c_call_args ~handle:"g" style;
9187 pr " if (%s == NULL)\n" n;
9188 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9189 pr " RETVAL = newSVpvn (%s, size);\n" n;
9190 pr " free (%s);\n" n;
9198 and generate_perl_struct_list_code typ cols name style n do_cleanups =
9200 pr " struct guestfs_%s_list *%s;\n" typ n;
9204 pr " %s = guestfs_%s " n name;
9205 generate_c_call_args ~handle:"g" style;
9208 pr " if (%s == NULL)\n" n;
9209 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9210 pr " EXTEND (SP, %s->len);\n" n;
9211 pr " for (i = 0; i < %s->len; ++i) {\n" n;
9212 pr " hv = newHV ();\n";
9216 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
9217 name (String.length name) n name
9219 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
9220 name (String.length name) n name
9222 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
9223 name (String.length name) n name n name
9224 | name, (FBytes|FUInt64) ->
9225 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
9226 name (String.length name) n name
9228 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
9229 name (String.length name) n name
9230 | name, (FInt32|FUInt32) ->
9231 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9232 name (String.length name) n name
9234 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
9235 name (String.length name) n name
9236 | name, FOptPercent ->
9237 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9238 name (String.length name) n name
9240 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
9242 pr " guestfs_free_%s_list (%s);\n" typ n
9244 and generate_perl_struct_code typ cols name style n do_cleanups =
9246 pr " struct guestfs_%s *%s;\n" typ n;
9248 pr " %s = guestfs_%s " n name;
9249 generate_c_call_args ~handle:"g" style;
9252 pr " if (%s == NULL)\n" n;
9253 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9254 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
9256 fun ((name, _) as col) ->
9257 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
9261 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
9264 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
9267 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
9269 | name, (FBytes|FUInt64) ->
9270 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
9273 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
9275 | name, (FInt32|FUInt32) ->
9276 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9279 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
9281 | name, FOptPercent ->
9282 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9285 pr " free (%s);\n" n
9287 (* Generate Sys/Guestfs.pm. *)
9288 and generate_perl_pm () =
9289 generate_header HashStyle LGPLv2plus;
9296 Sys::Guestfs - Perl bindings for libguestfs
9302 my $h = Sys::Guestfs->new ();
9303 $h->add_drive ('guest.img');
9305 $h->mount ('/dev/sda1', '/');
9306 $h->touch ('/hello');
9311 The C<Sys::Guestfs> module provides a Perl XS binding to the
9312 libguestfs API for examining and modifying virtual machine
9315 Amongst the things this is good for: making batch configuration
9316 changes to guests, getting disk used/free statistics (see also:
9317 virt-df), migrating between virtualization systems (see also:
9318 virt-p2v), performing partial backups, performing partial guest
9319 clones, cloning guests and changing registry/UUID/hostname info, and
9322 Libguestfs uses Linux kernel and qemu code, and can access any type of
9323 guest filesystem that Linux and qemu can, including but not limited
9324 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9325 schemes, qcow, qcow2, vmdk.
9327 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9328 LVs, what filesystem is in each LV, etc.). It can also run commands
9329 in the context of the guest. Also you can access filesystems over
9332 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
9333 functions for using libguestfs from Perl, including integration
9338 All errors turn into calls to C<croak> (see L<Carp(3)>).
9346 package Sys::Guestfs;
9351 # This version number changes whenever a new function
9352 # is added to the libguestfs API. It is not directly
9353 # related to the libguestfs version number.
9354 use vars qw($VERSION);
9358 XSLoader::load ('Sys::Guestfs');
9360 =item $h = Sys::Guestfs->new ();
9362 Create a new guestfs handle.
9368 my $class = ref ($proto) || $proto;
9370 my $g = Sys::Guestfs::_create ();
9371 my $self = { _g => $g };
9372 bless $self, $class;
9378 Explicitly close the guestfs handle.
9380 B<Note:> You should not usually call this function. The handle will
9381 be closed implicitly when its reference count goes to zero (eg.
9382 when it goes out of scope or the program ends). This call is
9383 only required in some exceptional cases, such as where the program
9384 may contain cached references to the handle 'somewhere' and you
9385 really have to have the close happen right away. After calling
9386 C<close> the program must not call any method (including C<close>)
9387 on the handle (but the implicit call to C<DESTROY> that happens
9388 when the final reference is cleaned up is OK).
9394 (* Actions. We only need to print documentation for these as
9395 * they are pulled in from the XS code automatically.
9398 fun (name, style, _, flags, _, _, longdesc) ->
9399 if not (List.mem NotInDocs flags) then (
9400 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9402 generate_perl_prototype name style;
9404 pr "%s\n\n" longdesc;
9405 if List.mem ProtocolLimitWarning flags then
9406 pr "%s\n\n" protocol_limit_warning;
9407 if List.mem DangerWillRobinson flags then
9408 pr "%s\n\n" danger_will_robinson;
9409 match deprecation_notice flags with
9411 | Some txt -> pr "%s\n\n" txt
9413 ) all_functions_sorted;
9425 Copyright (C) %s Red Hat Inc.
9429 Please see the file COPYING.LIB for the full license.
9435 L<http://libguestfs.org>,
9436 L<Sys::Guestfs::Lib(3)>.
9441 and generate_perl_prototype name style =
9442 (match fst style with
9450 | RBufferOut n -> pr "$%s = " n
9452 | RHashtable n -> pr "%%%s = " n
9454 | RStructList (n,_) -> pr "@%s = " n
9457 let comma = ref false in
9460 if !comma then pr ", ";
9463 | Pathname n | Device n | Dev_or_Path n | String n
9464 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9465 | BufferIn n | Key n ->
9467 | StringList n | DeviceList n ->
9472 (* Generate Python C module. *)
9473 and generate_python_c () =
9474 generate_header CStyle LGPLv2plus;
9477 #define PY_SSIZE_T_CLEAN 1
9480 #if PY_VERSION_HEX < 0x02050000
9481 typedef int Py_ssize_t;
9482 #define PY_SSIZE_T_MAX INT_MAX
9483 #define PY_SSIZE_T_MIN INT_MIN
9490 #include \"guestfs.h\"
9492 #ifndef HAVE_PYCAPSULE_NEW
9500 get_handle (PyObject *obj)
9503 assert (obj != Py_None);
9504 #ifndef HAVE_PYCAPSULE_NEW
9505 return ((Pyguestfs_Object *) obj)->g;
9507 return (guestfs_h*) PyCapsule_GetPointer(obj, \"guestfs_h\");
9512 put_handle (guestfs_h *g)
9515 #ifndef HAVE_PYCAPSULE_NEW
9517 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9519 return PyCapsule_New ((void *) g, \"guestfs_h\", NULL);
9523 /* This list should be freed (but not the strings) after use. */
9525 get_string_list (PyObject *obj)
9532 if (!PyList_Check (obj)) {
9533 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9537 Py_ssize_t slen = PyList_Size (obj);
9539 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: PyList_Size failure\");
9542 len = (size_t) slen;
9543 r = malloc (sizeof (char *) * (len+1));
9545 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9549 for (i = 0; i < len; ++i)
9550 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9557 put_string_list (char * const * const argv)
9562 for (argc = 0; argv[argc] != NULL; ++argc)
9565 list = PyList_New (argc);
9566 for (i = 0; i < argc; ++i)
9567 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9573 put_table (char * const * const argv)
9575 PyObject *list, *item;
9578 for (argc = 0; argv[argc] != NULL; ++argc)
9581 list = PyList_New (argc >> 1);
9582 for (i = 0; i < argc; i += 2) {
9583 item = PyTuple_New (2);
9584 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9585 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9586 PyList_SetItem (list, i >> 1, item);
9593 free_strings (char **argv)
9597 for (argc = 0; argv[argc] != NULL; ++argc)
9603 py_guestfs_create (PyObject *self, PyObject *args)
9607 g = guestfs_create ();
9609 PyErr_SetString (PyExc_RuntimeError,
9610 \"guestfs.create: failed to allocate handle\");
9613 guestfs_set_error_handler (g, NULL, NULL);
9614 /* This can return NULL, but in that case put_handle will have
9615 * set the Python error string.
9617 return put_handle (g);
9621 py_guestfs_close (PyObject *self, PyObject *args)
9626 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9628 g = get_handle (py_g);
9632 Py_INCREF (Py_None);
9638 let emit_put_list_function typ =
9639 pr "static PyObject *\n";
9640 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9642 pr " PyObject *list;\n";
9645 pr " list = PyList_New (%ss->len);\n" typ;
9646 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9647 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9648 pr " return list;\n";
9653 (* Structures, turned into Python dictionaries. *)
9656 pr "static PyObject *\n";
9657 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9659 pr " PyObject *dict;\n";
9661 pr " dict = PyDict_New ();\n";
9665 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9666 pr " PyString_FromString (%s->%s));\n"
9669 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9670 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9673 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9674 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9676 | name, (FBytes|FUInt64) ->
9677 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9678 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9681 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9682 pr " PyLong_FromLongLong (%s->%s));\n"
9685 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9686 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9689 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9690 pr " PyLong_FromLong (%s->%s));\n"
9692 | name, FOptPercent ->
9693 pr " if (%s->%s >= 0)\n" typ name;
9694 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9695 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9698 pr " Py_INCREF (Py_None);\n";
9699 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9702 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9703 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9705 pr " return dict;\n";
9711 (* Emit a put_TYPE_list function definition only if that function is used. *)
9714 | typ, (RStructListOnly | RStructAndList) ->
9715 (* generate the function for typ *)
9716 emit_put_list_function typ
9717 | typ, _ -> () (* empty *)
9718 ) (rstructs_used_by all_functions);
9720 (* Python wrapper functions. *)
9722 fun (name, style, _, _, _, _, _) ->
9723 pr "static PyObject *\n";
9724 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9727 pr " PyObject *py_g;\n";
9728 pr " guestfs_h *g;\n";
9729 pr " PyObject *py_r;\n";
9732 match fst style with
9733 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9734 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9735 | RConstString _ | RConstOptString _ ->
9736 pr " const char *r;\n"; "NULL"
9737 | RString _ -> pr " char *r;\n"; "NULL"
9738 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9739 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9740 | RStructList (_, typ) ->
9741 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9744 pr " size_t size;\n";
9749 | Pathname n | Device n | Dev_or_Path n | String n | Key n
9750 | FileIn n | FileOut n ->
9751 pr " const char *%s;\n" n
9752 | OptString n -> pr " const char *%s;\n" n
9754 pr " const char *%s;\n" n;
9755 pr " Py_ssize_t %s_size;\n" n
9756 | StringList n | DeviceList n ->
9757 pr " PyObject *py_%s;\n" n;
9758 pr " char **%s;\n" n
9759 | Bool n -> pr " int %s;\n" n
9760 | Int n -> pr " int %s;\n" n
9761 | Int64 n -> pr " long long %s;\n" n
9766 (* Convert the parameters. *)
9767 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9770 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
9771 | FileIn _ | FileOut _ -> pr "s"
9772 | OptString _ -> pr "z"
9773 | StringList _ | DeviceList _ -> pr "O"
9774 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9776 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9777 * emulate C's int/long/long long in Python?
9779 | BufferIn _ -> pr "s#"
9781 pr ":guestfs_%s\",\n" name;
9785 | Pathname n | Device n | Dev_or_Path n | String n | Key n
9786 | FileIn n | FileOut n -> pr ", &%s" n
9787 | OptString n -> pr ", &%s" n
9788 | StringList n | DeviceList n -> pr ", &py_%s" n
9789 | Bool n -> pr ", &%s" n
9790 | Int n -> pr ", &%s" n
9791 | Int64 n -> pr ", &%s" n
9792 | BufferIn n -> pr ", &%s, &%s_size" n n
9796 pr " return NULL;\n";
9798 pr " g = get_handle (py_g);\n";
9801 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
9802 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9804 | StringList n | DeviceList n ->
9805 pr " %s = get_string_list (py_%s);\n" n n;
9806 pr " if (!%s) return NULL;\n" n
9811 pr " r = guestfs_%s " name;
9812 generate_c_call_args ~handle:"g" style;
9817 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
9818 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9820 | StringList n | DeviceList n ->
9821 pr " free (%s);\n" n
9824 pr " if (r == %s) {\n" error_code;
9825 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9826 pr " return NULL;\n";
9830 (match fst style with
9832 pr " Py_INCREF (Py_None);\n";
9833 pr " py_r = Py_None;\n"
9835 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9836 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9837 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9838 | RConstOptString _ ->
9840 pr " py_r = PyString_FromString (r);\n";
9842 pr " Py_INCREF (Py_None);\n";
9843 pr " py_r = Py_None;\n";
9846 pr " py_r = PyString_FromString (r);\n";
9849 pr " py_r = put_string_list (r);\n";
9850 pr " free_strings (r);\n"
9851 | RStruct (_, typ) ->
9852 pr " py_r = put_%s (r);\n" typ;
9853 pr " guestfs_free_%s (r);\n" typ
9854 | RStructList (_, typ) ->
9855 pr " py_r = put_%s_list (r);\n" typ;
9856 pr " guestfs_free_%s_list (r);\n" typ
9858 pr " py_r = put_table (r);\n";
9859 pr " free_strings (r);\n"
9861 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9865 pr " return py_r;\n";
9870 (* Table of functions. *)
9871 pr "static PyMethodDef methods[] = {\n";
9872 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9873 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9875 fun (name, _, _, _, _, _, _) ->
9876 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9879 pr " { NULL, NULL, 0, NULL }\n";
9883 (* Init function. *)
9886 initlibguestfsmod (void)
9888 static int initialized = 0;
9890 if (initialized) return;
9891 Py_InitModule ((char *) \"libguestfsmod\", methods);
9896 (* Generate Python module. *)
9897 and generate_python_py () =
9898 generate_header HashStyle LGPLv2plus;
9901 u\"\"\"Python bindings for libguestfs
9904 g = guestfs.GuestFS ()
9905 g.add_drive (\"guest.img\")
9907 parts = g.list_partitions ()
9909 The guestfs module provides a Python binding to the libguestfs API
9910 for examining and modifying virtual machine disk images.
9912 Amongst the things this is good for: making batch configuration
9913 changes to guests, getting disk used/free statistics (see also:
9914 virt-df), migrating between virtualization systems (see also:
9915 virt-p2v), performing partial backups, performing partial guest
9916 clones, cloning guests and changing registry/UUID/hostname info, and
9919 Libguestfs uses Linux kernel and qemu code, and can access any type of
9920 guest filesystem that Linux and qemu can, including but not limited
9921 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9922 schemes, qcow, qcow2, vmdk.
9924 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9925 LVs, what filesystem is in each LV, etc.). It can also run commands
9926 in the context of the guest. Also you can access filesystems over
9929 Errors which happen while using the API are turned into Python
9930 RuntimeError exceptions.
9932 To create a guestfs handle you usually have to perform the following
9935 # Create the handle, call add_drive at least once, and possibly
9936 # several times if the guest has multiple block devices:
9937 g = guestfs.GuestFS ()
9938 g.add_drive (\"guest.img\")
9940 # Launch the qemu subprocess and wait for it to become ready:
9943 # Now you can issue commands, for example:
9948 import libguestfsmod
9951 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9953 def __init__ (self):
9954 \"\"\"Create a new libguestfs handle.\"\"\"
9955 self._o = libguestfsmod.create ()
9958 libguestfsmod.close (self._o)
9963 fun (name, style, _, flags, _, _, longdesc) ->
9965 generate_py_call_args ~handle:"self" (snd style);
9968 if not (List.mem NotInDocs flags) then (
9969 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9971 match fst style with
9972 | RErr | RInt _ | RInt64 _ | RBool _
9973 | RConstOptString _ | RConstString _
9974 | RString _ | RBufferOut _ -> doc
9976 doc ^ "\n\nThis function returns a list of strings."
9977 | RStruct (_, typ) ->
9978 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9979 | RStructList (_, typ) ->
9980 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9982 doc ^ "\n\nThis function returns a dictionary." in
9984 if List.mem ProtocolLimitWarning flags then
9985 doc ^ "\n\n" ^ protocol_limit_warning
9988 if List.mem DangerWillRobinson flags then
9989 doc ^ "\n\n" ^ danger_will_robinson
9992 match deprecation_notice flags with
9994 | Some txt -> doc ^ "\n\n" ^ txt in
9995 let doc = pod2text ~width:60 name doc in
9996 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9997 let doc = String.concat "\n " doc in
9998 pr " u\"\"\"%s\"\"\"\n" doc;
10000 pr " return libguestfsmod.%s " name;
10001 generate_py_call_args ~handle:"self._o" (snd style);
10006 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
10007 and generate_py_call_args ~handle args =
10009 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10012 (* Useful if you need the longdesc POD text as plain text. Returns a
10015 * Because this is very slow (the slowest part of autogeneration),
10016 * we memoize the results.
10018 and pod2text ~width name longdesc =
10019 let key = width, name, longdesc in
10020 try Hashtbl.find pod2text_memo key
10022 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
10023 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
10025 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
10026 let chan = open_process_in cmd in
10027 let lines = ref [] in
10029 let line = input_line chan in
10030 if i = 1 then (* discard the first line of output *)
10033 let line = triml line in
10034 lines := line :: !lines;
10037 let lines = try loop 1 with End_of_file -> List.rev !lines in
10039 (match close_process_in chan with
10042 failwithf "pod2text: process exited with non-zero status (%d)" i
10043 | WSIGNALED i | WSTOPPED i ->
10044 failwithf "pod2text: process signalled or stopped by signal %d" i
10046 Hashtbl.add pod2text_memo key lines;
10047 pod2text_memo_updated ();
10050 (* Generate ruby bindings. *)
10051 and generate_ruby_c () =
10052 generate_header CStyle LGPLv2plus;
10056 #include <stdlib.h>
10060 #include \"guestfs.h\"
10062 #include \"extconf.h\"
10064 /* For Ruby < 1.9 */
10066 #define RARRAY_LEN(r) (RARRAY((r))->len)
10069 static VALUE m_guestfs; /* guestfs module */
10070 static VALUE c_guestfs; /* guestfs_h handle */
10071 static VALUE e_Error; /* used for all errors */
10073 static void ruby_guestfs_free (void *p)
10076 guestfs_close ((guestfs_h *) p);
10079 static VALUE ruby_guestfs_create (VALUE m)
10083 g = guestfs_create ();
10085 rb_raise (e_Error, \"failed to create guestfs handle\");
10087 /* Don't print error messages to stderr by default. */
10088 guestfs_set_error_handler (g, NULL, NULL);
10090 /* Wrap it, and make sure the close function is called when the
10091 * handle goes away.
10093 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
10096 static VALUE ruby_guestfs_close (VALUE gv)
10099 Data_Get_Struct (gv, guestfs_h, g);
10101 ruby_guestfs_free (g);
10102 DATA_PTR (gv) = NULL;
10110 fun (name, style, _, _, _, _, _) ->
10111 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
10112 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
10115 pr " guestfs_h *g;\n";
10116 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
10118 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
10124 | Pathname n | Device n | Dev_or_Path n | String n | Key n
10125 | FileIn n | FileOut n ->
10126 pr " Check_Type (%sv, T_STRING);\n" n;
10127 pr " const char *%s = StringValueCStr (%sv);\n" n n;
10128 pr " if (!%s)\n" n;
10129 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
10130 pr " \"%s\", \"%s\");\n" n name
10132 pr " Check_Type (%sv, T_STRING);\n" n;
10133 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
10134 pr " if (!%s)\n" n;
10135 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
10136 pr " \"%s\", \"%s\");\n" n name;
10137 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
10139 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
10140 | StringList n | DeviceList n ->
10141 pr " char **%s;\n" n;
10142 pr " Check_Type (%sv, T_ARRAY);\n" n;
10144 pr " size_t i, len;\n";
10145 pr " len = RARRAY_LEN (%sv);\n" n;
10146 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
10148 pr " for (i = 0; i < len; ++i) {\n";
10149 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
10150 pr " %s[i] = StringValueCStr (v);\n" n;
10152 pr " %s[len] = NULL;\n" n;
10155 pr " int %s = RTEST (%sv);\n" n n
10157 pr " int %s = NUM2INT (%sv);\n" n n
10159 pr " long long %s = NUM2LL (%sv);\n" n n
10164 match fst style with
10165 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
10166 | RInt64 _ -> pr " int64_t r;\n"; "-1"
10167 | RConstString _ | RConstOptString _ ->
10168 pr " const char *r;\n"; "NULL"
10169 | RString _ -> pr " char *r;\n"; "NULL"
10170 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
10171 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
10172 | RStructList (_, typ) ->
10173 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
10176 pr " size_t size;\n";
10180 pr " r = guestfs_%s " name;
10181 generate_c_call_args ~handle:"g" style;
10186 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _
10187 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
10189 | StringList n | DeviceList n ->
10190 pr " free (%s);\n" n
10193 pr " if (r == %s)\n" error_code;
10194 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
10197 (match fst style with
10199 pr " return Qnil;\n"
10200 | RInt _ | RBool _ ->
10201 pr " return INT2NUM (r);\n"
10203 pr " return ULL2NUM (r);\n"
10204 | RConstString _ ->
10205 pr " return rb_str_new2 (r);\n";
10206 | RConstOptString _ ->
10208 pr " return rb_str_new2 (r);\n";
10210 pr " return Qnil;\n";
10212 pr " VALUE rv = rb_str_new2 (r);\n";
10214 pr " return rv;\n";
10216 pr " size_t i, len = 0;\n";
10217 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
10218 pr " VALUE rv = rb_ary_new2 (len);\n";
10219 pr " for (i = 0; r[i] != NULL; ++i) {\n";
10220 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
10221 pr " free (r[i]);\n";
10225 | RStruct (_, typ) ->
10226 let cols = cols_of_struct typ in
10227 generate_ruby_struct_code typ cols
10228 | RStructList (_, typ) ->
10229 let cols = cols_of_struct typ in
10230 generate_ruby_struct_list_code typ cols
10232 pr " VALUE rv = rb_hash_new ();\n";
10234 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
10235 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
10236 pr " free (r[i]);\n";
10237 pr " free (r[i+1]);\n";
10242 pr " VALUE rv = rb_str_new (r, size);\n";
10244 pr " return rv;\n";
10252 /* Initialize the module. */
10253 void Init__guestfs ()
10255 m_guestfs = rb_define_module (\"Guestfs\");
10256 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
10257 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
10259 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
10260 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
10263 (* Define the rest of the methods. *)
10265 fun (name, style, _, _, _, _, _) ->
10266 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
10267 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
10272 (* Ruby code to return a struct. *)
10273 and generate_ruby_struct_code typ cols =
10274 pr " VALUE rv = rb_hash_new ();\n";
10278 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
10280 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
10282 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
10283 | name, (FBytes|FUInt64) ->
10284 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10286 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
10288 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
10290 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
10291 | name, FOptPercent ->
10292 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
10293 | name, FChar -> (* XXX wrong? *)
10294 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10296 pr " guestfs_free_%s (r);\n" typ;
10299 (* Ruby code to return a struct list. *)
10300 and generate_ruby_struct_list_code typ cols =
10301 pr " VALUE rv = rb_ary_new2 (r->len);\n";
10303 pr " for (i = 0; i < r->len; ++i) {\n";
10304 pr " VALUE hv = rb_hash_new ();\n";
10308 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
10310 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
10312 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
10313 | name, (FBytes|FUInt64) ->
10314 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10316 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
10318 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
10320 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
10321 | name, FOptPercent ->
10322 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
10323 | name, FChar -> (* XXX wrong? *)
10324 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10326 pr " rb_ary_push (rv, hv);\n";
10328 pr " guestfs_free_%s_list (r);\n" typ;
10331 (* Generate Java bindings GuestFS.java file. *)
10332 and generate_java_java () =
10333 generate_header CStyle LGPLv2plus;
10336 package com.redhat.et.libguestfs;
10338 import java.util.HashMap;
10339 import com.redhat.et.libguestfs.LibGuestFSException;
10340 import com.redhat.et.libguestfs.PV;
10341 import com.redhat.et.libguestfs.VG;
10342 import com.redhat.et.libguestfs.LV;
10343 import com.redhat.et.libguestfs.Stat;
10344 import com.redhat.et.libguestfs.StatVFS;
10345 import com.redhat.et.libguestfs.IntBool;
10346 import com.redhat.et.libguestfs.Dirent;
10349 * The GuestFS object is a libguestfs handle.
10353 public class GuestFS {
10354 // Load the native code.
10356 System.loadLibrary (\"guestfs_jni\");
10360 * The native guestfs_h pointer.
10365 * Create a libguestfs handle.
10367 * @throws LibGuestFSException
10369 public GuestFS () throws LibGuestFSException
10373 private native long _create () throws LibGuestFSException;
10376 * Close a libguestfs handle.
10378 * You can also leave handles to be collected by the garbage
10379 * collector, but this method ensures that the resources used
10380 * by the handle are freed up immediately. If you call any
10381 * other methods after closing the handle, you will get an
10384 * @throws LibGuestFSException
10386 public void close () throws LibGuestFSException
10392 private native void _close (long g) throws LibGuestFSException;
10394 public void finalize () throws LibGuestFSException
10402 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10403 if not (List.mem NotInDocs flags); then (
10404 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10406 if List.mem ProtocolLimitWarning flags then
10407 doc ^ "\n\n" ^ protocol_limit_warning
10410 if List.mem DangerWillRobinson flags then
10411 doc ^ "\n\n" ^ danger_will_robinson
10414 match deprecation_notice flags with
10416 | Some txt -> doc ^ "\n\n" ^ txt in
10417 let doc = pod2text ~width:60 name doc in
10418 let doc = List.map ( (* RHBZ#501883 *)
10421 | nonempty -> nonempty
10423 let doc = String.concat "\n * " doc in
10426 pr " * %s\n" shortdesc;
10429 pr " * @throws LibGuestFSException\n";
10433 generate_java_prototype ~public:true ~semicolon:false name style;
10436 pr " if (g == 0)\n";
10437 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10440 if fst style <> RErr then pr "return ";
10442 generate_java_call_args ~handle:"g" (snd style);
10446 generate_java_prototype ~privat:true ~native:true name style;
10453 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10454 and generate_java_call_args ~handle args =
10456 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10459 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10460 ?(semicolon=true) name style =
10461 if privat then pr "private ";
10462 if public then pr "public ";
10463 if native then pr "native ";
10466 (match fst style with
10467 | RErr -> pr "void ";
10468 | RInt _ -> pr "int ";
10469 | RInt64 _ -> pr "long ";
10470 | RBool _ -> pr "boolean ";
10471 | RConstString _ | RConstOptString _ | RString _
10472 | RBufferOut _ -> pr "String ";
10473 | RStringList _ -> pr "String[] ";
10474 | RStruct (_, typ) ->
10475 let name = java_name_of_struct typ in
10477 | RStructList (_, typ) ->
10478 let name = java_name_of_struct typ in
10480 | RHashtable _ -> pr "HashMap<String,String> ";
10483 if native then pr "_%s " name else pr "%s " name;
10485 let needs_comma = ref false in
10488 needs_comma := true
10494 if !needs_comma then pr ", ";
10495 needs_comma := true;
10499 | Device n | Dev_or_Path n
10508 | StringList n | DeviceList n ->
10519 pr " throws LibGuestFSException";
10520 if semicolon then pr ";"
10522 and generate_java_struct jtyp cols () =
10523 generate_header CStyle LGPLv2plus;
10526 package com.redhat.et.libguestfs;
10529 * Libguestfs %s structure.
10541 | name, FBuffer -> pr " public String %s;\n" name
10542 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10543 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10544 | name, FChar -> pr " public char %s;\n" name
10545 | name, FOptPercent ->
10546 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10547 pr " public float %s;\n" name
10552 and generate_java_c () =
10553 generate_header CStyle LGPLv2plus;
10557 #include <stdlib.h>
10558 #include <string.h>
10560 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10561 #include \"guestfs.h\"
10563 /* Note that this function returns. The exception is not thrown
10564 * until after the wrapper function returns.
10567 throw_exception (JNIEnv *env, const char *msg)
10570 cl = (*env)->FindClass (env,
10571 \"com/redhat/et/libguestfs/LibGuestFSException\");
10572 (*env)->ThrowNew (env, cl, msg);
10575 JNIEXPORT jlong JNICALL
10576 Java_com_redhat_et_libguestfs_GuestFS__1create
10577 (JNIEnv *env, jobject obj)
10581 g = guestfs_create ();
10583 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10586 guestfs_set_error_handler (g, NULL, NULL);
10587 return (jlong) (long) g;
10590 JNIEXPORT void JNICALL
10591 Java_com_redhat_et_libguestfs_GuestFS__1close
10592 (JNIEnv *env, jobject obj, jlong jg)
10594 guestfs_h *g = (guestfs_h *) (long) jg;
10601 fun (name, style, _, _, _, _, _) ->
10603 (match fst style with
10604 | RErr -> pr "void ";
10605 | RInt _ -> pr "jint ";
10606 | RInt64 _ -> pr "jlong ";
10607 | RBool _ -> pr "jboolean ";
10608 | RConstString _ | RConstOptString _ | RString _
10609 | RBufferOut _ -> pr "jstring ";
10610 | RStruct _ | RHashtable _ ->
10612 | RStringList _ | RStructList _ ->
10613 pr "jobjectArray ";
10616 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10617 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10619 pr " (JNIEnv *env, jobject obj, jlong jg";
10623 | Device n | Dev_or_Path n
10629 pr ", jstring j%s" n
10631 pr ", jbyteArray j%s" n
10632 | StringList n | DeviceList n ->
10633 pr ", jobjectArray j%s" n
10635 pr ", jboolean j%s" n
10643 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10644 let error_code, no_ret =
10645 match fst style with
10646 | RErr -> pr " int r;\n"; "-1", ""
10648 | RInt _ -> pr " int r;\n"; "-1", "0"
10649 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10650 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10651 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10653 pr " jstring jr;\n";
10654 pr " char *r;\n"; "NULL", "NULL"
10656 pr " jobjectArray jr;\n";
10657 pr " int r_len;\n";
10658 pr " jclass cl;\n";
10659 pr " jstring jstr;\n";
10660 pr " char **r;\n"; "NULL", "NULL"
10661 | RStruct (_, typ) ->
10662 pr " jobject jr;\n";
10663 pr " jclass cl;\n";
10664 pr " jfieldID fl;\n";
10665 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10666 | RStructList (_, typ) ->
10667 pr " jobjectArray jr;\n";
10668 pr " jclass cl;\n";
10669 pr " jfieldID fl;\n";
10670 pr " jobject jfl;\n";
10671 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10672 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10674 pr " jstring jr;\n";
10676 pr " size_t size;\n";
10681 | Device n | Dev_or_Path n
10687 pr " const char *%s;\n" n
10689 pr " jbyte *%s;\n" n;
10690 pr " size_t %s_size;\n" n
10691 | StringList n | DeviceList n ->
10692 pr " int %s_len;\n" n;
10693 pr " const char **%s;\n" n
10698 pr " int64_t %s;\n" n
10702 (match fst style with
10703 | RStringList _ | RStructList _ -> true
10704 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10705 | RConstOptString _
10706 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10707 List.exists (function
10708 | StringList _ -> true
10709 | DeviceList _ -> true
10710 | _ -> false) (snd style) in
10716 (* Get the parameters. *)
10720 | Device n | Dev_or_Path n
10725 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10727 (* This is completely undocumented, but Java null becomes
10728 * a NULL parameter.
10730 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10732 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10733 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10734 | StringList n | DeviceList n ->
10735 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10736 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10737 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10738 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10740 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10742 pr " %s[%s_len] = NULL;\n" n n;
10746 pr " %s = j%s;\n" n n
10749 (* Make the call. *)
10750 pr " r = guestfs_%s " name;
10751 generate_c_call_args ~handle:"g" style;
10754 (* Release the parameters. *)
10758 | Device n | Dev_or_Path n
10763 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10765 pr " if (j%s)\n" n;
10766 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10768 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10769 | StringList n | DeviceList n ->
10770 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10771 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10773 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10775 pr " free (%s);\n" n
10781 (* Check for errors. *)
10782 pr " if (r == %s) {\n" error_code;
10783 pr " throw_exception (env, guestfs_last_error (g));\n";
10784 pr " return %s;\n" no_ret;
10787 (* Return value. *)
10788 (match fst style with
10790 | RInt _ -> pr " return (jint) r;\n"
10791 | RBool _ -> pr " return (jboolean) r;\n"
10792 | RInt64 _ -> pr " return (jlong) r;\n"
10793 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10794 | RConstOptString _ ->
10795 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10797 pr " jr = (*env)->NewStringUTF (env, r);\n";
10801 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10802 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10803 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10804 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10805 pr " for (i = 0; i < r_len; ++i) {\n";
10806 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10807 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10808 pr " free (r[i]);\n";
10812 | RStruct (_, typ) ->
10813 let jtyp = java_name_of_struct typ in
10814 let cols = cols_of_struct typ in
10815 generate_java_struct_return typ jtyp cols
10816 | RStructList (_, typ) ->
10817 let jtyp = java_name_of_struct typ in
10818 let cols = cols_of_struct typ in
10819 generate_java_struct_list_return typ jtyp cols
10822 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10823 pr " return NULL;\n"
10825 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10834 and generate_java_struct_return typ jtyp cols =
10835 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10836 pr " jr = (*env)->AllocObject (env, cl);\n";
10840 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10841 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10844 pr " char s[33];\n";
10845 pr " memcpy (s, r->%s, 32);\n" name;
10846 pr " s[32] = 0;\n";
10847 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10848 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10852 pr " int len = r->%s_len;\n" name;
10853 pr " char s[len+1];\n";
10854 pr " memcpy (s, r->%s, len);\n" name;
10855 pr " s[len] = 0;\n";
10856 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10857 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10859 | name, (FBytes|FUInt64|FInt64) ->
10860 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10861 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10862 | name, (FUInt32|FInt32) ->
10863 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10864 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10865 | name, FOptPercent ->
10866 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10867 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10869 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10870 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10875 and generate_java_struct_list_return typ jtyp cols =
10876 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10877 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10878 pr " for (i = 0; i < r->len; ++i) {\n";
10879 pr " jfl = (*env)->AllocObject (env, cl);\n";
10883 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10884 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10887 pr " char s[33];\n";
10888 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10889 pr " s[32] = 0;\n";
10890 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10891 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10895 pr " int len = r->val[i].%s_len;\n" name;
10896 pr " char s[len+1];\n";
10897 pr " memcpy (s, r->val[i].%s, len);\n" name;
10898 pr " s[len] = 0;\n";
10899 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10900 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10902 | name, (FBytes|FUInt64|FInt64) ->
10903 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10904 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10905 | name, (FUInt32|FInt32) ->
10906 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10907 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10908 | name, FOptPercent ->
10909 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10910 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10912 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10913 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10915 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10917 pr " guestfs_free_%s_list (r);\n" typ;
10920 and generate_java_makefile_inc () =
10921 generate_header HashStyle GPLv2plus;
10923 pr "java_built_sources = \\\n";
10926 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10928 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10930 and generate_haskell_hs () =
10931 generate_header HaskellStyle LGPLv2plus;
10933 (* XXX We only know how to generate partial FFI for Haskell
10934 * at the moment. Please help out!
10936 let can_generate style =
10940 | RInt64 _, _ -> true
10942 | RConstString _, _
10943 | RConstOptString _, _
10949 | RBufferOut _, _ -> false in
10952 {-# INCLUDE <guestfs.h> #-}
10953 {-# LANGUAGE ForeignFunctionInterface #-}
10958 (* List out the names of the actions we want to export. *)
10960 fun (name, style, _, _, _, _, _) ->
10961 if can_generate style then pr ",\n %s" name
10967 -- Unfortunately some symbols duplicate ones already present
10968 -- in Prelude. We don't know which, so we hard-code a list
10970 import Prelude hiding (truncate)
10974 import Foreign.C.Types
10976 import Control.Exception
10977 import Data.Typeable
10979 data GuestfsS = GuestfsS -- represents the opaque C struct
10980 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10981 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10983 -- XXX define properly later XXX
10987 data IntBool = IntBool
10989 data StatVFS = StatVFS
10990 data Hashtable = Hashtable
10992 foreign import ccall unsafe \"guestfs_create\" c_create
10994 foreign import ccall unsafe \"&guestfs_close\" c_close
10995 :: FunPtr (GuestfsP -> IO ())
10996 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10997 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10999 create :: IO GuestfsH
11002 c_set_error_handler p nullPtr nullPtr
11003 h <- newForeignPtr c_close p
11006 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
11007 :: GuestfsP -> IO CString
11009 -- last_error :: GuestfsH -> IO (Maybe String)
11010 -- last_error h = do
11011 -- str <- withForeignPtr h (\\p -> c_last_error p)
11012 -- maybePeek peekCString str
11014 last_error :: GuestfsH -> IO (String)
11016 str <- withForeignPtr h (\\p -> c_last_error p)
11017 if (str == nullPtr)
11018 then return \"no error\"
11019 else peekCString str
11023 (* Generate wrappers for each foreign function. *)
11025 fun (name, style, _, _, _, _, _) ->
11026 if can_generate style then (
11027 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
11029 generate_haskell_prototype ~handle:"GuestfsP" style;
11033 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
11035 pr "%s %s = do\n" name
11036 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
11038 (* Convert pointer arguments using with* functions. *)
11043 | Pathname n | Device n | Dev_or_Path n | String n | Key n ->
11044 pr "withCString %s $ \\%s -> " n n
11046 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
11047 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
11048 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
11049 | Bool _ | Int _ | Int64 _ -> ()
11051 (* Convert integer arguments. *)
11055 | Bool n -> sprintf "(fromBool %s)" n
11056 | Int n -> sprintf "(fromIntegral %s)" n
11057 | Int64 n -> sprintf "(fromIntegral %s)" n
11058 | FileIn n | FileOut n
11059 | Pathname n | Device n | Dev_or_Path n
11060 | String n | OptString n
11061 | StringList n | DeviceList n
11063 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
11065 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
11066 (String.concat " " ("p" :: args));
11067 (match fst style with
11068 | RErr | RInt _ | RInt64 _ | RBool _ ->
11069 pr " if (r == -1)\n";
11071 pr " err <- last_error h\n";
11073 | RConstString _ | RConstOptString _ | RString _
11074 | RStringList _ | RStruct _
11075 | RStructList _ | RHashtable _ | RBufferOut _ ->
11076 pr " if (r == nullPtr)\n";
11078 pr " err <- last_error h\n";
11081 (match fst style with
11083 pr " else return ()\n"
11085 pr " else return (fromIntegral r)\n"
11087 pr " else return (fromIntegral r)\n"
11089 pr " else return (toBool r)\n"
11091 | RConstOptString _
11098 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
11104 and generate_haskell_prototype ~handle ?(hs = false) style =
11105 pr "%s -> " handle;
11106 let string = if hs then "String" else "CString" in
11107 let int = if hs then "Int" else "CInt" in
11108 let bool = if hs then "Bool" else "CInt" in
11109 let int64 = if hs then "Integer" else "Int64" in
11113 | Pathname _ | Device _ | Dev_or_Path _ | String _ | Key _ ->
11116 if hs then pr "String"
11117 else pr "CString -> CInt"
11118 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
11119 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
11120 | Bool _ -> pr "%s" bool
11121 | Int _ -> pr "%s" int
11122 | Int64 _ -> pr "%s" int
11123 | FileIn _ -> pr "%s" string
11124 | FileOut _ -> pr "%s" string
11129 (match fst style with
11130 | RErr -> if not hs then pr "CInt"
11131 | RInt _ -> pr "%s" int
11132 | RInt64 _ -> pr "%s" int64
11133 | RBool _ -> pr "%s" bool
11134 | RConstString _ -> pr "%s" string
11135 | RConstOptString _ -> pr "Maybe %s" string
11136 | RString _ -> pr "%s" string
11137 | RStringList _ -> pr "[%s]" string
11138 | RStruct (_, typ) ->
11139 let name = java_name_of_struct typ in
11141 | RStructList (_, typ) ->
11142 let name = java_name_of_struct typ in
11144 | RHashtable _ -> pr "Hashtable"
11145 | RBufferOut _ -> pr "%s" string
11149 and generate_csharp () =
11150 generate_header CPlusPlusStyle LGPLv2plus;
11152 (* XXX Make this configurable by the C# assembly users. *)
11153 let library = "libguestfs.so.0" in
11156 // These C# bindings are highly experimental at present.
11158 // Firstly they only work on Linux (ie. Mono). In order to get them
11159 // to work on Windows (ie. .Net) you would need to port the library
11160 // itself to Windows first.
11162 // The second issue is that some calls are known to be incorrect and
11163 // can cause Mono to segfault. Particularly: calls which pass or
11164 // return string[], or return any structure value. This is because
11165 // we haven't worked out the correct way to do this from C#.
11167 // The third issue is that when compiling you get a lot of warnings.
11168 // We are not sure whether the warnings are important or not.
11170 // Fourthly we do not routinely build or test these bindings as part
11171 // of the make && make check cycle, which means that regressions might
11174 // Suggestions and patches are welcome.
11178 // gmcs Libguestfs.cs
11179 // mono Libguestfs.exe
11181 // (You'll probably want to add a Test class / static main function
11182 // otherwise this won't do anything useful).
11186 using System.Runtime.InteropServices;
11187 using System.Runtime.Serialization;
11188 using System.Collections;
11192 class Error : System.ApplicationException
11194 public Error (string message) : base (message) {}
11195 protected Error (SerializationInfo info, StreamingContext context) {}
11202 [DllImport (\"%s\")]
11203 static extern IntPtr guestfs_create ();
11207 _handle = guestfs_create ();
11208 if (_handle == IntPtr.Zero)
11209 throw new Error (\"could not create guestfs handle\");
11212 [DllImport (\"%s\")]
11213 static extern void guestfs_close (IntPtr h);
11217 guestfs_close (_handle);
11220 [DllImport (\"%s\")]
11221 static extern string guestfs_last_error (IntPtr h);
11223 " library library library;
11225 (* Generate C# structure bindings. We prefix struct names with
11226 * underscore because C# cannot have conflicting struct names and
11227 * method names (eg. "class stat" and "stat").
11231 pr " [StructLayout (LayoutKind.Sequential)]\n";
11232 pr " public class _%s {\n" typ;
11235 | name, FChar -> pr " char %s;\n" name
11236 | name, FString -> pr " string %s;\n" name
11238 pr " uint %s_len;\n" name;
11239 pr " string %s;\n" name
11241 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
11242 pr " string %s;\n" name
11243 | name, FUInt32 -> pr " uint %s;\n" name
11244 | name, FInt32 -> pr " int %s;\n" name
11245 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
11246 | name, FInt64 -> pr " long %s;\n" name
11247 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
11253 (* Generate C# function bindings. *)
11255 fun (name, style, _, _, _, shortdesc, _) ->
11256 let rec csharp_return_type () =
11257 match fst style with
11259 | RBool n -> "bool"
11261 | RInt64 n -> "long"
11263 | RConstOptString n
11265 | RBufferOut n -> "string"
11266 | RStruct (_,n) -> "_" ^ n
11267 | RHashtable n -> "Hashtable"
11268 | RStringList n -> "string[]"
11269 | RStructList (_,n) -> sprintf "_%s[]" n
11271 and c_return_type () =
11272 match fst style with
11276 | RInt64 _ -> "long"
11278 | RConstOptString _
11280 | RBufferOut _ -> "string"
11281 | RStruct (_,n) -> "_" ^ n
11283 | RStringList _ -> "string[]"
11284 | RStructList (_,n) -> sprintf "_%s[]" n
11286 and c_error_comparison () =
11287 match fst style with
11291 | RInt64 _ -> "== -1"
11293 | RConstOptString _
11299 | RStructList (_,_) -> "== null"
11301 and generate_extern_prototype () =
11302 pr " static extern %s guestfs_%s (IntPtr h"
11303 (c_return_type ()) name;
11306 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11307 | FileIn n | FileOut n
11310 pr ", [In] string %s" n
11311 | StringList n | DeviceList n ->
11312 pr ", [In] string[] %s" n
11322 and generate_public_prototype () =
11323 pr " public %s %s (" (csharp_return_type ()) name;
11324 let comma = ref false in
11326 if !comma then pr ", ";
11331 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11332 | FileIn n | FileOut n
11335 next (); pr "string %s" n
11336 | StringList n | DeviceList n ->
11337 next (); pr "string[] %s" n
11339 next (); pr "bool %s" n
11341 next (); pr "int %s" n
11343 next (); pr "long %s" n
11347 and generate_call () =
11348 pr "guestfs_%s (_handle" name;
11349 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
11353 pr " [DllImport (\"%s\")]\n" library;
11354 generate_extern_prototype ();
11356 pr " /// <summary>\n";
11357 pr " /// %s\n" shortdesc;
11358 pr " /// </summary>\n";
11359 generate_public_prototype ();
11361 pr " %s r;\n" (c_return_type ());
11364 pr " if (r %s)\n" (c_error_comparison ());
11365 pr " throw new Error (guestfs_last_error (_handle));\n";
11366 (match fst style with
11369 pr " return r != 0 ? true : false;\n"
11371 pr " Hashtable rr = new Hashtable ();\n";
11372 pr " for (size_t i = 0; i < r.Length; i += 2)\n";
11373 pr " rr.Add (r[i], r[i+1]);\n";
11375 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
11376 | RString _ | RBufferOut _ | RStruct _ | RStringList _
11382 ) all_functions_sorted;
11388 and generate_bindtests () =
11389 generate_header CStyle LGPLv2plus;
11393 #include <stdlib.h>
11394 #include <inttypes.h>
11395 #include <string.h>
11397 #include \"guestfs.h\"
11398 #include \"guestfs-internal.h\"
11399 #include \"guestfs-internal-actions.h\"
11400 #include \"guestfs_protocol.h\"
11402 #define error guestfs_error
11403 #define safe_calloc guestfs_safe_calloc
11404 #define safe_malloc guestfs_safe_malloc
11407 print_strings (char *const *argv)
11412 for (argc = 0; argv[argc] != NULL; ++argc) {
11413 if (argc > 0) printf (\", \");
11414 printf (\"\\\"%%s\\\"\", argv[argc]);
11419 /* The test0 function prints its parameters to stdout. */
11423 match test_functions with
11424 | [] -> assert false
11425 | test0 :: tests -> test0, tests in
11428 let (name, style, _, _, _, _, _) = test0 in
11429 generate_prototype ~extern:false ~semicolon:false ~newline:true
11430 ~handle:"g" ~prefix:"guestfs__" name style;
11435 | Device n | Dev_or_Path n
11439 | Key n -> pr " printf (\"%%s\\n\", %s);\n" n
11443 pr " for (i = 0; i < %s_size; ++i)\n" n;
11444 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11445 pr " printf (\"\\n\");\n";
11447 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11448 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11449 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11450 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11451 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11453 pr " /* Java changes stdout line buffering so we need this: */\n";
11454 pr " fflush (stdout);\n";
11460 fun (name, style, _, _, _, _, _) ->
11461 if String.sub name (String.length name - 3) 3 <> "err" then (
11462 pr "/* Test normal return. */\n";
11463 generate_prototype ~extern:false ~semicolon:false ~newline:true
11464 ~handle:"g" ~prefix:"guestfs__" name style;
11466 (match fst style with
11471 pr " sscanf (val, \"%%d\", &r);\n";
11474 pr " int64_t r;\n";
11475 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11478 pr " return STREQ (val, \"true\");\n"
11480 | RConstOptString _ ->
11481 (* Can't return the input string here. Return a static
11482 * string so we ensure we get a segfault if the caller
11483 * tries to free it.
11485 pr " return \"static string\";\n"
11487 pr " return strdup (val);\n"
11489 pr " char **strs;\n";
11491 pr " sscanf (val, \"%%d\", &n);\n";
11492 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11493 pr " for (i = 0; i < n; ++i) {\n";
11494 pr " strs[i] = safe_malloc (g, 16);\n";
11495 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11497 pr " strs[n] = NULL;\n";
11498 pr " return strs;\n"
11499 | RStruct (_, typ) ->
11500 pr " struct guestfs_%s *r;\n" typ;
11501 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11503 | RStructList (_, typ) ->
11504 pr " struct guestfs_%s_list *r;\n" typ;
11505 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11506 pr " sscanf (val, \"%%d\", &r->len);\n";
11507 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11510 pr " char **strs;\n";
11512 pr " sscanf (val, \"%%d\", &n);\n";
11513 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11514 pr " for (i = 0; i < n; ++i) {\n";
11515 pr " strs[i*2] = safe_malloc (g, 16);\n";
11516 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11517 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11518 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11520 pr " strs[n*2] = NULL;\n";
11521 pr " return strs;\n"
11523 pr " return strdup (val);\n"
11528 pr "/* Test error return. */\n";
11529 generate_prototype ~extern:false ~semicolon:false ~newline:true
11530 ~handle:"g" ~prefix:"guestfs__" name style;
11532 pr " error (g, \"error\");\n";
11533 (match fst style with
11534 | RErr | RInt _ | RInt64 _ | RBool _ ->
11536 | RConstString _ | RConstOptString _
11537 | RString _ | RStringList _ | RStruct _
11541 pr " return NULL;\n"
11548 and generate_ocaml_bindtests () =
11549 generate_header OCamlStyle GPLv2plus;
11553 let g = Guestfs.create () in
11557 String.concat " " (
11560 | CallString s -> "\"" ^ s ^ "\""
11561 | CallOptString None -> "None"
11562 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11563 | CallStringList xs ->
11564 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11565 | CallInt i when i >= 0 -> string_of_int i
11566 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11567 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11568 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11569 | CallBool b -> string_of_bool b
11570 | CallBuffer s -> sprintf "%S" s
11575 generate_lang_bindtests (
11576 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11579 pr "print_endline \"EOF\"\n"
11581 and generate_perl_bindtests () =
11582 pr "#!/usr/bin/perl -w\n";
11583 generate_header HashStyle GPLv2plus;
11590 my $g = Sys::Guestfs->new ();
11594 String.concat ", " (
11597 | CallString s -> "\"" ^ s ^ "\""
11598 | CallOptString None -> "undef"
11599 | CallOptString (Some s) -> sprintf "\"%s\"" s
11600 | CallStringList xs ->
11601 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11602 | CallInt i -> string_of_int i
11603 | CallInt64 i -> Int64.to_string i
11604 | CallBool b -> if b then "1" else "0"
11605 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11610 generate_lang_bindtests (
11611 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11614 pr "print \"EOF\\n\"\n"
11616 and generate_python_bindtests () =
11617 generate_header HashStyle GPLv2plus;
11622 g = guestfs.GuestFS ()
11626 String.concat ", " (
11629 | CallString s -> "\"" ^ s ^ "\""
11630 | CallOptString None -> "None"
11631 | CallOptString (Some s) -> sprintf "\"%s\"" s
11632 | CallStringList xs ->
11633 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11634 | CallInt i -> string_of_int i
11635 | CallInt64 i -> Int64.to_string i
11636 | CallBool b -> if b then "1" else "0"
11637 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11642 generate_lang_bindtests (
11643 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11646 pr "print \"EOF\"\n"
11648 and generate_ruby_bindtests () =
11649 generate_header HashStyle GPLv2plus;
11654 g = Guestfs::create()
11658 String.concat ", " (
11661 | CallString s -> "\"" ^ s ^ "\""
11662 | CallOptString None -> "nil"
11663 | CallOptString (Some s) -> sprintf "\"%s\"" s
11664 | CallStringList xs ->
11665 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11666 | CallInt i -> string_of_int i
11667 | CallInt64 i -> Int64.to_string i
11668 | CallBool b -> string_of_bool b
11669 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11674 generate_lang_bindtests (
11675 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11678 pr "print \"EOF\\n\"\n"
11680 and generate_java_bindtests () =
11681 generate_header CStyle GPLv2plus;
11684 import com.redhat.et.libguestfs.*;
11686 public class Bindtests {
11687 public static void main (String[] argv)
11690 GuestFS g = new GuestFS ();
11694 String.concat ", " (
11697 | CallString s -> "\"" ^ s ^ "\""
11698 | CallOptString None -> "null"
11699 | CallOptString (Some s) -> sprintf "\"%s\"" s
11700 | CallStringList xs ->
11702 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11703 | CallInt i -> string_of_int i
11704 | CallInt64 i -> Int64.to_string i
11705 | CallBool b -> string_of_bool b
11707 "new byte[] { " ^ String.concat "," (
11708 map_chars (fun c -> string_of_int (Char.code c)) s
11714 generate_lang_bindtests (
11715 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11719 System.out.println (\"EOF\");
11721 catch (Exception exn) {
11722 System.err.println (exn);
11729 and generate_haskell_bindtests () =
11730 generate_header HaskellStyle GPLv2plus;
11733 module Bindtests where
11734 import qualified Guestfs
11737 g <- Guestfs.create
11741 String.concat " " (
11744 | CallString s -> "\"" ^ s ^ "\""
11745 | CallOptString None -> "Nothing"
11746 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11747 | CallStringList xs ->
11748 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11749 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11750 | CallInt i -> string_of_int i
11751 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11752 | CallInt64 i -> Int64.to_string i
11753 | CallBool true -> "True"
11754 | CallBool false -> "False"
11755 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11760 generate_lang_bindtests (
11761 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11764 pr " putStrLn \"EOF\"\n"
11766 (* Language-independent bindings tests - we do it this way to
11767 * ensure there is parity in testing bindings across all languages.
11769 and generate_lang_bindtests call =
11770 call "test0" [CallString "abc"; CallOptString (Some "def");
11771 CallStringList []; CallBool false;
11772 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11773 CallBuffer "abc\000abc"];
11774 call "test0" [CallString "abc"; CallOptString None;
11775 CallStringList []; CallBool false;
11776 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11777 CallBuffer "abc\000abc"];
11778 call "test0" [CallString ""; CallOptString (Some "def");
11779 CallStringList []; CallBool false;
11780 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11781 CallBuffer "abc\000abc"];
11782 call "test0" [CallString ""; CallOptString (Some "");
11783 CallStringList []; CallBool false;
11784 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11785 CallBuffer "abc\000abc"];
11786 call "test0" [CallString "abc"; CallOptString (Some "def");
11787 CallStringList ["1"]; CallBool false;
11788 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11789 CallBuffer "abc\000abc"];
11790 call "test0" [CallString "abc"; CallOptString (Some "def");
11791 CallStringList ["1"; "2"]; CallBool false;
11792 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11793 CallBuffer "abc\000abc"];
11794 call "test0" [CallString "abc"; CallOptString (Some "def");
11795 CallStringList ["1"]; CallBool true;
11796 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11797 CallBuffer "abc\000abc"];
11798 call "test0" [CallString "abc"; CallOptString (Some "def");
11799 CallStringList ["1"]; CallBool false;
11800 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11801 CallBuffer "abc\000abc"];
11802 call "test0" [CallString "abc"; CallOptString (Some "def");
11803 CallStringList ["1"]; CallBool false;
11804 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11805 CallBuffer "abc\000abc"];
11806 call "test0" [CallString "abc"; CallOptString (Some "def");
11807 CallStringList ["1"]; CallBool false;
11808 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11809 CallBuffer "abc\000abc"];
11810 call "test0" [CallString "abc"; CallOptString (Some "def");
11811 CallStringList ["1"]; CallBool false;
11812 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11813 CallBuffer "abc\000abc"];
11814 call "test0" [CallString "abc"; CallOptString (Some "def");
11815 CallStringList ["1"]; CallBool false;
11816 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11817 CallBuffer "abc\000abc"];
11818 call "test0" [CallString "abc"; CallOptString (Some "def");
11819 CallStringList ["1"]; CallBool false;
11820 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11821 CallBuffer "abc\000abc"]
11823 (* XXX Add here tests of the return and error functions. *)
11825 (* Code to generator bindings for virt-inspector. Currently only
11826 * implemented for OCaml code (for virt-p2v 2.0).
11828 let rng_input = "inspector/virt-inspector.rng"
11830 (* Read the input file and parse it into internal structures. This is
11831 * by no means a complete RELAX NG parser, but is just enough to be
11832 * able to parse the specific input file.
11835 | Element of string * rng list (* <element name=name/> *)
11836 | Attribute of string * rng list (* <attribute name=name/> *)
11837 | Interleave of rng list (* <interleave/> *)
11838 | ZeroOrMore of rng (* <zeroOrMore/> *)
11839 | OneOrMore of rng (* <oneOrMore/> *)
11840 | Optional of rng (* <optional/> *)
11841 | Choice of string list (* <choice><value/>*</choice> *)
11842 | Value of string (* <value>str</value> *)
11843 | Text (* <text/> *)
11845 let rec string_of_rng = function
11846 | Element (name, xs) ->
11847 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11848 | Attribute (name, xs) ->
11849 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11850 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11851 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11852 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11853 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11854 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11855 | Value value -> "Value \"" ^ value ^ "\""
11858 and string_of_rng_list xs =
11859 String.concat ", " (List.map string_of_rng xs)
11861 let rec parse_rng ?defines context = function
11863 | Xml.Element ("element", ["name", name], children) :: rest ->
11864 Element (name, parse_rng ?defines context children)
11865 :: parse_rng ?defines context rest
11866 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11867 Attribute (name, parse_rng ?defines context children)
11868 :: parse_rng ?defines context rest
11869 | Xml.Element ("interleave", [], children) :: rest ->
11870 Interleave (parse_rng ?defines context children)
11871 :: parse_rng ?defines context rest
11872 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11873 let rng = parse_rng ?defines context [child] in
11875 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11877 failwithf "%s: <zeroOrMore> contains more than one child element"
11880 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11881 let rng = parse_rng ?defines context [child] in
11883 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11885 failwithf "%s: <oneOrMore> contains more than one child element"
11888 | Xml.Element ("optional", [], [child]) :: rest ->
11889 let rng = parse_rng ?defines context [child] in
11891 | [child] -> Optional child :: parse_rng ?defines context rest
11893 failwithf "%s: <optional> contains more than one child element"
11896 | Xml.Element ("choice", [], children) :: rest ->
11897 let values = List.map (
11898 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11900 failwithf "%s: can't handle anything except <value> in <choice>"
11904 :: parse_rng ?defines context rest
11905 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11906 Value value :: parse_rng ?defines context rest
11907 | Xml.Element ("text", [], []) :: rest ->
11908 Text :: parse_rng ?defines context rest
11909 | Xml.Element ("ref", ["name", name], []) :: rest ->
11910 (* Look up the reference. Because of limitations in this parser,
11911 * we can't handle arbitrarily nested <ref> yet. You can only
11912 * use <ref> from inside <start>.
11914 (match defines with
11916 failwithf "%s: contains <ref>, but no refs are defined yet" context
11918 let rng = StringMap.find name map in
11919 rng @ parse_rng ?defines context rest
11922 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11925 let xml = Xml.parse_file rng_input in
11927 | Xml.Element ("grammar", _,
11928 Xml.Element ("start", _, gram) :: defines) ->
11929 (* The <define/> elements are referenced in the <start> section,
11930 * so build a map of those first.
11932 let defines = List.fold_left (
11934 function Xml.Element ("define", ["name", name], defn) ->
11935 StringMap.add name defn map
11937 failwithf "%s: expected <define name=name/>" rng_input
11938 ) StringMap.empty defines in
11939 let defines = StringMap.mapi parse_rng defines in
11941 (* Parse the <start> clause, passing the defines. *)
11942 parse_rng ~defines "<start>" gram
11944 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11947 let name_of_field = function
11948 | Element (name, _) | Attribute (name, _)
11949 | ZeroOrMore (Element (name, _))
11950 | OneOrMore (Element (name, _))
11951 | Optional (Element (name, _)) -> name
11952 | Optional (Attribute (name, _)) -> name
11953 | Text -> (* an unnamed field in an element *)
11956 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11958 (* At the moment this function only generates OCaml types. However we
11959 * should parameterize it later so it can generate types/structs in a
11960 * variety of languages.
11962 let generate_types xs =
11963 (* A simple type is one that can be printed out directly, eg.
11964 * "string option". A complex type is one which has a name and has
11965 * to be defined via another toplevel definition, eg. a struct.
11967 * generate_type generates code for either simple or complex types.
11968 * In the simple case, it returns the string ("string option"). In
11969 * the complex case, it returns the name ("mountpoint"). In the
11970 * complex case it has to print out the definition before returning,
11971 * so it should only be called when we are at the beginning of a
11972 * new line (BOL context).
11974 let rec generate_type = function
11975 | Text -> (* string *)
11977 | Choice values -> (* [`val1|`val2|...] *)
11978 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11979 | ZeroOrMore rng -> (* <rng> list *)
11980 let t, is_simple = generate_type rng in
11981 t ^ " list (* 0 or more *)", is_simple
11982 | OneOrMore rng -> (* <rng> list *)
11983 let t, is_simple = generate_type rng in
11984 t ^ " list (* 1 or more *)", is_simple
11985 (* virt-inspector hack: bool *)
11986 | Optional (Attribute (name, [Value "1"])) ->
11988 | Optional rng -> (* <rng> list *)
11989 let t, is_simple = generate_type rng in
11990 t ^ " option", is_simple
11991 (* type name = { fields ... } *)
11992 | Element (name, fields) when is_attrs_interleave fields ->
11993 generate_type_struct name (get_attrs_interleave fields)
11994 | Element (name, [field]) (* type name = field *)
11995 | Attribute (name, [field]) ->
11996 let t, is_simple = generate_type field in
11997 if is_simple then (t, true)
11999 pr "type %s = %s\n" name t;
12002 | Element (name, fields) -> (* type name = { fields ... } *)
12003 generate_type_struct name fields
12005 failwithf "generate_type failed at: %s" (string_of_rng rng)
12007 and is_attrs_interleave = function
12008 | [Interleave _] -> true
12009 | Attribute _ :: fields -> is_attrs_interleave fields
12010 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
12013 and get_attrs_interleave = function
12014 | [Interleave fields] -> fields
12015 | ((Attribute _) as field) :: fields
12016 | ((Optional (Attribute _)) as field) :: fields ->
12017 field :: get_attrs_interleave fields
12018 | _ -> assert false
12020 and generate_types xs =
12021 List.iter (fun x -> ignore (generate_type x)) xs
12023 and generate_type_struct name fields =
12024 (* Calculate the types of the fields first. We have to do this
12025 * before printing anything so we are still in BOL context.
12027 let types = List.map fst (List.map generate_type fields) in
12029 (* Special case of a struct containing just a string and another
12030 * field. Turn it into an assoc list.
12033 | ["string"; other] ->
12034 let fname1, fname2 =
12036 | [f1; f2] -> name_of_field f1, name_of_field f2
12037 | _ -> assert false in
12038 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
12042 pr "type %s = {\n" name;
12044 fun (field, ftype) ->
12045 let fname = name_of_field field in
12046 pr " %s_%s : %s;\n" name fname ftype
12047 ) (List.combine fields types);
12049 (* Return the name of this type, and
12050 * false because it's not a simple type.
12057 let generate_parsers xs =
12058 (* As for generate_type above, generate_parser makes a parser for
12059 * some type, and returns the name of the parser it has generated.
12060 * Because it (may) need to print something, it should always be
12061 * called in BOL context.
12063 let rec generate_parser = function
12064 | Text -> (* string *)
12065 "string_child_or_empty"
12066 | Choice values -> (* [`val1|`val2|...] *)
12067 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
12069 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
12070 | ZeroOrMore rng -> (* <rng> list *)
12071 let pa = generate_parser rng in
12072 sprintf "(fun x -> List.map %s (Xml.children x))" pa
12073 | OneOrMore rng -> (* <rng> list *)
12074 let pa = generate_parser rng in
12075 sprintf "(fun x -> List.map %s (Xml.children x))" pa
12076 (* virt-inspector hack: bool *)
12077 | Optional (Attribute (name, [Value "1"])) ->
12078 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
12079 | Optional rng -> (* <rng> list *)
12080 let pa = generate_parser rng in
12081 sprintf "(function None -> None | Some x -> Some (%s x))" pa
12082 (* type name = { fields ... } *)
12083 | Element (name, fields) when is_attrs_interleave fields ->
12084 generate_parser_struct name (get_attrs_interleave fields)
12085 | Element (name, [field]) -> (* type name = field *)
12086 let pa = generate_parser field in
12087 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
12088 pr "let %s =\n" parser_name;
12090 pr "let parse_%s = %s\n" name parser_name;
12092 | Attribute (name, [field]) ->
12093 let pa = generate_parser field in
12094 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
12095 pr "let %s =\n" parser_name;
12097 pr "let parse_%s = %s\n" name parser_name;
12099 | Element (name, fields) -> (* type name = { fields ... } *)
12100 generate_parser_struct name ([], fields)
12102 failwithf "generate_parser failed at: %s" (string_of_rng rng)
12104 and is_attrs_interleave = function
12105 | [Interleave _] -> true
12106 | Attribute _ :: fields -> is_attrs_interleave fields
12107 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
12110 and get_attrs_interleave = function
12111 | [Interleave fields] -> [], fields
12112 | ((Attribute _) as field) :: fields
12113 | ((Optional (Attribute _)) as field) :: fields ->
12114 let attrs, interleaves = get_attrs_interleave fields in
12115 (field :: attrs), interleaves
12116 | _ -> assert false
12118 and generate_parsers xs =
12119 List.iter (fun x -> ignore (generate_parser x)) xs
12121 and generate_parser_struct name (attrs, interleaves) =
12122 (* Generate parsers for the fields first. We have to do this
12123 * before printing anything so we are still in BOL context.
12125 let fields = attrs @ interleaves in
12126 let pas = List.map generate_parser fields in
12128 (* Generate an intermediate tuple from all the fields first.
12129 * If the type is just a string + another field, then we will
12130 * return this directly, otherwise it is turned into a record.
12132 * RELAX NG note: This code treats <interleave> and plain lists of
12133 * fields the same. In other words, it doesn't bother enforcing
12134 * any ordering of fields in the XML.
12136 pr "let parse_%s x =\n" name;
12137 pr " let t = (\n ";
12138 let comma = ref false in
12141 if !comma then pr ",\n ";
12144 | Optional (Attribute (fname, [field])), pa ->
12146 | Optional (Element (fname, [field])), pa ->
12147 pr "%s (optional_child %S x)" pa fname
12148 | Attribute (fname, [Text]), _ ->
12149 pr "attribute %S x" fname
12150 | (ZeroOrMore _ | OneOrMore _), pa ->
12155 let fname = name_of_field field in
12156 pr "%s (child %S x)" pa fname
12157 ) (List.combine fields pas);
12161 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
12165 pr " (Obj.magic t : %s)\n" name
12169 | (Optional (Attribute (fname, [field])), pa) ->
12170 pr " %s_%s =\n" name fname;
12172 | (Optional (Element (fname, [field])), pa) ->
12173 pr " %s_%s =\n" name fname;
12174 pr " (let x = optional_child %S x in\n" fname;
12177 let fname = name_of_field field in
12178 pr " %s_%s =\n" name fname;
12179 pr " (let x = child %S x in\n" fname;
12181 ) (List.combine fields pas);
12185 sprintf "parse_%s" name
12188 generate_parsers xs
12190 (* Generate ocaml/guestfs_inspector.mli. *)
12191 let generate_ocaml_inspector_mli () =
12192 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
12195 (** This is an OCaml language binding to the external [virt-inspector]
12198 For more information, please read the man page [virt-inspector(1)].
12203 generate_types grammar;
12204 pr "(** The nested information returned from the {!inspect} function. *)\n";
12208 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
12209 (** To inspect a libvirt domain called [name], pass a singleton
12210 list: [inspect [name]]. When using libvirt only, you may
12211 optionally pass a libvirt URI using [inspect ~connect:uri ...].
12213 To inspect a disk image or images, pass a list of the filenames
12214 of the disk images: [inspect filenames]
12216 This function inspects the given guest or disk images and
12217 returns a list of operating system(s) found and a large amount
12218 of information about them. In the vast majority of cases,
12219 a virtual machine only contains a single operating system.
12221 If the optional [~xml] parameter is given, then this function
12222 skips running the external virt-inspector program and just
12223 parses the given XML directly (which is expected to be XML
12224 produced from a previous run of virt-inspector). The list of
12225 names and connect URI are ignored in this case.
12227 This function can throw a wide variety of exceptions, for example
12228 if the external virt-inspector program cannot be found, or if
12229 it doesn't generate valid XML.
12233 (* Generate ocaml/guestfs_inspector.ml. *)
12234 let generate_ocaml_inspector_ml () =
12235 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
12240 generate_types grammar;
12244 (* Misc functions which are used by the parser code below. *)
12245 let first_child = function
12246 | Xml.Element (_, _, c::_) -> c
12247 | Xml.Element (name, _, []) ->
12248 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
12249 | Xml.PCData str ->
12250 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
12252 let string_child_or_empty = function
12253 | Xml.Element (_, _, [Xml.PCData s]) -> s
12254 | Xml.Element (_, _, []) -> \"\"
12255 | Xml.Element (x, _, _) ->
12256 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
12258 | Xml.PCData str ->
12259 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
12261 let optional_child name xml =
12262 let children = Xml.children xml in
12264 Some (List.find (function
12265 | Xml.Element (n, _, _) when n = name -> true
12266 | _ -> false) children)
12270 let child name xml =
12271 match optional_child name xml with
12274 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
12276 let attribute name xml =
12277 try Xml.attrib xml name
12278 with Xml.No_attribute _ ->
12279 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
12283 generate_parsers grammar;
12287 (* Run external virt-inspector, then use parser to parse the XML. *)
12288 let inspect ?connect ?xml names =
12292 if names = [] then invalid_arg \"inspect: no names given\";
12293 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
12294 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
12296 let cmd = List.map Filename.quote cmd in
12297 let cmd = String.concat \" \" cmd in
12298 let chan = open_process_in cmd in
12299 let xml = Xml.parse_in chan in
12300 (match close_process_in chan with
12302 | WEXITED _ -> failwith \"external virt-inspector command failed\"
12303 | WSIGNALED i | WSTOPPED i ->
12304 failwith (\"external virt-inspector command died or stopped on sig \" ^
12309 Xml.parse_string doc in
12310 parse_operatingsystems xml
12313 and generate_max_proc_nr () =
12314 pr "%d\n" max_proc_nr
12316 let output_to filename k =
12317 let filename_new = filename ^ ".new" in
12318 chan := open_out filename_new;
12321 chan := Pervasives.stdout;
12323 (* Is the new file different from the current file? *)
12324 if Sys.file_exists filename && files_equal filename filename_new then
12325 unlink filename_new (* same, so skip it *)
12327 (* different, overwrite old one *)
12328 (try chmod filename 0o644 with Unix_error _ -> ());
12329 rename filename_new filename;
12330 chmod filename 0o444;
12331 printf "written %s\n%!" filename;
12334 let perror msg = function
12335 | Unix_error (err, _, _) ->
12336 eprintf "%s: %s\n" msg (error_message err)
12338 eprintf "%s: %s\n" msg (Printexc.to_string exn)
12340 (* Main program. *)
12343 try openfile "HACKING" [O_RDWR] 0
12345 | Unix_error (ENOENT, _, _) ->
12347 You are probably running this from the wrong directory.
12348 Run it from the top source directory using the command
12353 perror "open: HACKING" exn;
12356 (* Acquire a lock so parallel builds won't try to run the generator
12357 * twice at the same time. Subsequent builds will wait for the first
12358 * one to finish. Note the lock is released implicitly when the
12361 (try lockf lock_fd F_LOCK 1
12363 perror "lock: HACKING" exn;
12366 check_functions ();
12368 output_to "src/guestfs_protocol.x" generate_xdr;
12369 output_to "src/guestfs-structs.h" generate_structs_h;
12370 output_to "src/guestfs-actions.h" generate_actions_h;
12371 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
12372 output_to "src/actions.c" generate_client_actions;
12373 output_to "src/bindtests.c" generate_bindtests;
12374 output_to "src/guestfs-structs.pod" generate_structs_pod;
12375 output_to "src/guestfs-actions.pod" generate_actions_pod;
12376 output_to "src/guestfs-availability.pod" generate_availability_pod;
12377 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
12378 output_to "src/libguestfs.syms" generate_linker_script;
12379 output_to "daemon/actions.h" generate_daemon_actions_h;
12380 output_to "daemon/stubs.c" generate_daemon_actions;
12381 output_to "daemon/names.c" generate_daemon_names;
12382 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
12383 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
12384 output_to "capitests/tests.c" generate_tests;
12385 output_to "fish/cmds.c" generate_fish_cmds;
12386 output_to "fish/completion.c" generate_fish_completion;
12387 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
12388 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
12389 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
12390 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
12391 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
12392 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
12393 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
12394 output_to "perl/Guestfs.xs" generate_perl_xs;
12395 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
12396 output_to "perl/bindtests.pl" generate_perl_bindtests;
12397 output_to "python/guestfs-py.c" generate_python_c;
12398 output_to "python/guestfs.py" generate_python_py;
12399 output_to "python/bindtests.py" generate_python_bindtests;
12400 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12401 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12402 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12406 let cols = cols_of_struct typ in
12407 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12408 output_to filename (generate_java_struct jtyp cols);
12411 output_to "java/Makefile.inc" generate_java_makefile_inc;
12412 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12413 output_to "java/Bindtests.java" generate_java_bindtests;
12414 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12415 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12416 output_to "csharp/Libguestfs.cs" generate_csharp;
12418 (* Always generate this file last, and unconditionally. It's used
12419 * by the Makefile to know when we must re-run the generator.
12421 let chan = open_out "src/stamp-generator" in
12422 fprintf chan "1\n";
12425 printf "generated %d lines of code\n" !lines