3 * Copyright (C) 2009-2010 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <const char *, size_t> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
179 | ProtocolLimitWarning (* display warning about protocol size limits *)
180 | DangerWillRobinson (* flags particularly dangerous commands *)
181 | FishAlias of string (* provide an alias for this cmd in guestfish *)
182 | FishOutput of fish_output_t (* how to display output in guestfish *)
183 | NotInFish (* do not export via guestfish *)
184 | NotInDocs (* do not add this function to documentation *)
185 | DeprecatedBy of string (* function is deprecated, use .. instead *)
186 | Optional of string (* function is part of an optional group *)
189 | FishOutputOctal (* for int return, print in octal *)
190 | FishOutputHexadecimal (* for int return, print in hex *)
192 (* You can supply zero or as many tests as you want per API call.
194 * Note that the test environment has 3 block devices, of size 500MB,
195 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
196 * a fourth ISO block device with some known files on it (/dev/sdd).
198 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
199 * Number of cylinders was 63 for IDE emulated disks with precisely
200 * the same size. How exactly this is calculated is a mystery.
202 * The ISO block device (/dev/sdd) comes from images/test.iso.
204 * To be able to run the tests in a reasonable amount of time,
205 * the virtual machine and block devices are reused between tests.
206 * So don't try testing kill_subprocess :-x
208 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
210 * Don't assume anything about the previous contents of the block
211 * devices. Use 'Init*' to create some initial scenarios.
213 * You can add a prerequisite clause to any individual test. This
214 * is a run-time check, which, if it fails, causes the test to be
215 * skipped. Useful if testing a command which might not work on
216 * all variations of libguestfs builds. A test that has prerequisite
217 * of 'Always' is run unconditionally.
219 * In addition, packagers can skip individual tests by setting the
220 * environment variables: eg:
221 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
222 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
224 type tests = (test_init * test_prereq * test) list
226 (* Run the command sequence and just expect nothing to fail. *)
229 (* Run the command sequence and expect the output of the final
230 * command to be the string.
232 | TestOutput of seq * string
234 (* Run the command sequence and expect the output of the final
235 * command to be the list of strings.
237 | TestOutputList of seq * string list
239 (* Run the command sequence and expect the output of the final
240 * command to be the list of block devices (could be either
241 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
242 * character of each string).
244 | TestOutputListOfDevices of seq * string list
246 (* Run the command sequence and expect the output of the final
247 * command to be the integer.
249 | TestOutputInt of seq * int
251 (* Run the command sequence and expect the output of the final
252 * command to be <op> <int>, eg. ">=", "1".
254 | TestOutputIntOp of seq * string * int
256 (* Run the command sequence and expect the output of the final
257 * command to be a true value (!= 0 or != NULL).
259 | TestOutputTrue of seq
261 (* Run the command sequence and expect the output of the final
262 * command to be a false value (== 0 or == NULL, but not an error).
264 | TestOutputFalse of seq
266 (* Run the command sequence and expect the output of the final
267 * command to be a list of the given length (but don't care about
270 | TestOutputLength of seq * int
272 (* Run the command sequence and expect the output of the final
273 * command to be a buffer (RBufferOut), ie. string + size.
275 | TestOutputBuffer of seq * string
277 (* Run the command sequence and expect the output of the final
278 * command to be a structure.
280 | TestOutputStruct of seq * test_field_compare list
282 (* Run the command sequence and expect the final command (only)
285 | TestLastFail of seq
287 and test_field_compare =
288 | CompareWithInt of string * int
289 | CompareWithIntOp of string * string * int
290 | CompareWithString of string * string
291 | CompareFieldsIntEq of string * string
292 | CompareFieldsStrEq of string * string
294 (* Test prerequisites. *)
296 (* Test always runs. *)
299 (* Test is currently disabled - eg. it fails, or it tests some
300 * unimplemented feature.
304 (* 'string' is some C code (a function body) that should return
305 * true or false. The test will run if the code returns true.
309 (* As for 'If' but the test runs _unless_ the code returns true. *)
312 (* Run the test only if 'string' is available in the daemon. *)
313 | IfAvailable of string
315 (* Some initial scenarios for testing. *)
317 (* Do nothing, block devices could contain random stuff including
318 * LVM PVs, and some filesystems might be mounted. This is usually
323 (* Block devices are empty and no filesystems are mounted. *)
326 (* /dev/sda contains a single partition /dev/sda1, with random
327 * content. /dev/sdb and /dev/sdc may have random content.
332 (* /dev/sda contains a single partition /dev/sda1, which is formatted
333 * as ext2, empty [except for lost+found] and mounted on /.
334 * /dev/sdb and /dev/sdc may have random content.
340 * /dev/sda1 (is a PV):
341 * /dev/VG/LV (size 8MB):
342 * formatted as ext2, empty [except for lost+found], mounted on /
343 * /dev/sdb and /dev/sdc may have random content.
347 (* /dev/sdd (the ISO, see images/ directory in source)
352 (* Sequence of commands for testing. *)
354 and cmd = string list
356 (* Note about long descriptions: When referring to another
357 * action, use the format C<guestfs_other> (ie. the full name of
358 * the C function). This will be replaced as appropriate in other
361 * Apart from that, long descriptions are just perldoc paragraphs.
364 (* Generate a random UUID (used in tests). *)
366 let chan = open_process_in "uuidgen" in
367 let uuid = input_line chan in
368 (match close_process_in chan with
371 failwith "uuidgen: process exited with non-zero status"
372 | WSIGNALED _ | WSTOPPED _ ->
373 failwith "uuidgen: process signalled or stopped by signal"
377 (* These test functions are used in the language binding tests. *)
379 let test_all_args = [
382 StringList "strlist";
391 let test_all_rets = [
392 (* except for RErr, which is tested thoroughly elsewhere *)
393 "test0rint", RInt "valout";
394 "test0rint64", RInt64 "valout";
395 "test0rbool", RBool "valout";
396 "test0rconststring", RConstString "valout";
397 "test0rconstoptstring", RConstOptString "valout";
398 "test0rstring", RString "valout";
399 "test0rstringlist", RStringList "valout";
400 "test0rstruct", RStruct ("valout", "lvm_pv");
401 "test0rstructlist", RStructList ("valout", "lvm_pv");
402 "test0rhashtable", RHashtable "valout";
405 let test_functions = [
406 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
408 "internal test function - do not use",
410 This is an internal test function which is used to test whether
411 the automatically generated bindings can handle every possible
412 parameter type correctly.
414 It echos the contents of each parameter to stdout.
416 You probably don't want to call this function.");
420 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
422 "internal test function - do not use",
424 This is an internal test function which is used to test whether
425 the automatically generated bindings can handle every possible
426 return type correctly.
428 It converts string C<val> to the return type.
430 You probably don't want to call this function.");
431 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
433 "internal test function - do not use",
435 This is an internal test function which is used to test whether
436 the automatically generated bindings can handle every possible
437 return type correctly.
439 This function always returns an error.
441 You probably don't want to call this function.")]
445 (* non_daemon_functions are any functions which don't get processed
446 * in the daemon, eg. functions for setting and getting local
447 * configuration values.
450 let non_daemon_functions = test_functions @ [
451 ("launch", (RErr, []), -1, [FishAlias "run"],
453 "launch the qemu subprocess",
455 Internally libguestfs is implemented by running a virtual machine
458 You should call this after configuring the handle
459 (eg. adding drives) but before performing any actions.");
461 ("wait_ready", (RErr, []), -1, [NotInFish],
463 "wait until the qemu subprocess launches (no op)",
465 This function is a no op.
467 In versions of the API E<lt> 1.0.71 you had to call this function
468 just after calling C<guestfs_launch> to wait for the launch
469 to complete. However this is no longer necessary because
470 C<guestfs_launch> now does the waiting.
472 If you see any calls to this function in code then you can just
473 remove them, unless you want to retain compatibility with older
474 versions of the API.");
476 ("kill_subprocess", (RErr, []), -1, [],
478 "kill the qemu subprocess",
480 This kills the qemu subprocess. You should never need to call this.");
482 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
484 "add an image to examine or modify",
486 This function adds a virtual machine disk image C<filename> to the
487 guest. The first time you call this function, the disk appears as IDE
488 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
491 You don't necessarily need to be root when using libguestfs. However
492 you obviously do need sufficient permissions to access the filename
493 for whatever operations you want to perform (ie. read access if you
494 just want to read the image or write access if you want to modify the
497 This is equivalent to the qemu parameter
498 C<-drive file=filename,cache=off,if=...>.
500 C<cache=off> is omitted in cases where it is not supported by
501 the underlying filesystem.
503 C<if=...> is set at compile time by the configuration option
504 C<./configure --with-drive-if=...>. In the rare case where you
505 might need to change this at run time, use C<guestfs_add_drive_with_if>
506 or C<guestfs_add_drive_ro_with_if>.
508 Note that this call checks for the existence of C<filename>. This
509 stops you from specifying other types of drive which are supported
510 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
511 the general C<guestfs_config> call instead.");
513 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
515 "add a CD-ROM disk image to examine",
517 This function adds a virtual CD-ROM disk image to the guest.
519 This is equivalent to the qemu parameter C<-cdrom filename>.
527 This call checks for the existence of C<filename>. This
528 stops you from specifying other types of drive which are supported
529 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
530 the general C<guestfs_config> call instead.
534 If you just want to add an ISO file (often you use this as an
535 efficient way to transfer large files into the guest), then you
536 should probably use C<guestfs_add_drive_ro> instead.
540 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
542 "add a drive in snapshot mode (read-only)",
544 This adds a drive in snapshot mode, making it effectively
547 Note that writes to the device are allowed, and will be seen for
548 the duration of the guestfs handle, but they are written
549 to a temporary file which is discarded as soon as the guestfs
550 handle is closed. We don't currently have any method to enable
551 changes to be committed, although qemu can support this.
553 This is equivalent to the qemu parameter
554 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
556 C<if=...> is set at compile time by the configuration option
557 C<./configure --with-drive-if=...>. In the rare case where you
558 might need to change this at run time, use C<guestfs_add_drive_with_if>
559 or C<guestfs_add_drive_ro_with_if>.
561 C<readonly=on> is only added where qemu supports this option.
563 Note that this call checks for the existence of C<filename>. This
564 stops you from specifying other types of drive which are supported
565 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
566 the general C<guestfs_config> call instead.");
568 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
570 "add qemu parameters",
572 This can be used to add arbitrary qemu command line parameters
573 of the form C<-param value>. Actually it's not quite arbitrary - we
574 prevent you from setting some parameters which would interfere with
575 parameters that we use.
577 The first character of C<param> string must be a C<-> (dash).
579 C<value> can be NULL.");
581 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
583 "set the qemu binary",
585 Set the qemu binary that we will use.
587 The default is chosen when the library was compiled by the
590 You can also override this by setting the C<LIBGUESTFS_QEMU>
591 environment variable.
593 Setting C<qemu> to C<NULL> restores the default qemu binary.
595 Note that you should call this function as early as possible
596 after creating the handle. This is because some pre-launch
597 operations depend on testing qemu features (by running C<qemu -help>).
598 If the qemu binary changes, we don't retest features, and
599 so you might see inconsistent results. Using the environment
600 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
601 the qemu binary at the same time as the handle is created.");
603 ("get_qemu", (RConstString "qemu", []), -1, [],
604 [InitNone, Always, TestRun (
606 "get the qemu binary",
608 Return the current qemu binary.
610 This is always non-NULL. If it wasn't set already, then this will
611 return the default qemu binary name.");
613 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
615 "set the search path",
617 Set the path that libguestfs searches for kernel and initrd.img.
619 The default is C<$libdir/guestfs> unless overridden by setting
620 C<LIBGUESTFS_PATH> environment variable.
622 Setting C<path> to C<NULL> restores the default path.");
624 ("get_path", (RConstString "path", []), -1, [],
625 [InitNone, Always, TestRun (
627 "get the search path",
629 Return the current search path.
631 This is always non-NULL. If it wasn't set already, then this will
632 return the default path.");
634 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
636 "add options to kernel command line",
638 This function is used to add additional options to the
639 guest kernel command line.
641 The default is C<NULL> unless overridden by setting
642 C<LIBGUESTFS_APPEND> environment variable.
644 Setting C<append> to C<NULL> means I<no> additional options
645 are passed (libguestfs always adds a few of its own).");
647 ("get_append", (RConstOptString "append", []), -1, [],
648 (* This cannot be tested with the current framework. The
649 * function can return NULL in normal operations, which the
650 * test framework interprets as an error.
653 "get the additional kernel options",
655 Return the additional kernel options which are added to the
656 guest kernel command line.
658 If C<NULL> then no options are added.");
660 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
664 If C<autosync> is true, this enables autosync. Libguestfs will make a
665 best effort attempt to run C<guestfs_umount_all> followed by
666 C<guestfs_sync> when the handle is closed
667 (also if the program exits without closing handles).
669 This is disabled by default (except in guestfish where it is
670 enabled by default).");
672 ("get_autosync", (RBool "autosync", []), -1, [],
673 [InitNone, Always, TestRun (
674 [["get_autosync"]])],
677 Get the autosync flag.");
679 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
683 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
685 Verbose messages are disabled unless the environment variable
686 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
688 ("get_verbose", (RBool "verbose", []), -1, [],
692 This returns the verbose messages flag.");
694 ("is_ready", (RBool "ready", []), -1, [],
695 [InitNone, Always, TestOutputTrue (
697 "is ready to accept commands",
699 This returns true iff this handle is ready to accept commands
700 (in the C<READY> state).
702 For more information on states, see L<guestfs(3)>.");
704 ("is_config", (RBool "config", []), -1, [],
705 [InitNone, Always, TestOutputFalse (
707 "is in configuration state",
709 This returns true iff this handle is being configured
710 (in the C<CONFIG> state).
712 For more information on states, see L<guestfs(3)>.");
714 ("is_launching", (RBool "launching", []), -1, [],
715 [InitNone, Always, TestOutputFalse (
716 [["is_launching"]])],
717 "is launching subprocess",
719 This returns true iff this handle is launching the subprocess
720 (in the C<LAUNCHING> state).
722 For more information on states, see L<guestfs(3)>.");
724 ("is_busy", (RBool "busy", []), -1, [],
725 [InitNone, Always, TestOutputFalse (
727 "is busy processing a command",
729 This returns true iff this handle is busy processing a command
730 (in the C<BUSY> state).
732 For more information on states, see L<guestfs(3)>.");
734 ("get_state", (RInt "state", []), -1, [],
736 "get the current state",
738 This returns the current state as an opaque integer. This is
739 only useful for printing debug and internal error messages.
741 For more information on states, see L<guestfs(3)>.");
743 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
744 [InitNone, Always, TestOutputInt (
745 [["set_memsize"; "500"];
746 ["get_memsize"]], 500)],
747 "set memory allocated to the qemu subprocess",
749 This sets the memory size in megabytes allocated to the
750 qemu subprocess. This only has any effect if called before
753 You can also change this by setting the environment
754 variable C<LIBGUESTFS_MEMSIZE> before the handle is
757 For more information on the architecture of libguestfs,
758 see L<guestfs(3)>.");
760 ("get_memsize", (RInt "memsize", []), -1, [],
761 [InitNone, Always, TestOutputIntOp (
762 [["get_memsize"]], ">=", 256)],
763 "get memory allocated to the qemu subprocess",
765 This gets the memory size in megabytes allocated to the
768 If C<guestfs_set_memsize> was not called
769 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
770 then this returns the compiled-in default value for memsize.
772 For more information on the architecture of libguestfs,
773 see L<guestfs(3)>.");
775 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
776 [InitNone, Always, TestOutputIntOp (
777 [["get_pid"]], ">=", 1)],
778 "get PID of qemu subprocess",
780 Return the process ID of the qemu subprocess. If there is no
781 qemu subprocess, then this will return an error.
783 This is an internal call used for debugging and testing.");
785 ("version", (RStruct ("version", "version"), []), -1, [],
786 [InitNone, Always, TestOutputStruct (
787 [["version"]], [CompareWithInt ("major", 1)])],
788 "get the library version number",
790 Return the libguestfs version number that the program is linked
793 Note that because of dynamic linking this is not necessarily
794 the version of libguestfs that you compiled against. You can
795 compile the program, and then at runtime dynamically link
796 against a completely different C<libguestfs.so> library.
798 This call was added in version C<1.0.58>. In previous
799 versions of libguestfs there was no way to get the version
800 number. From C code you can use dynamic linker functions
801 to find out if this symbol exists (if it doesn't, then
802 it's an earlier version).
804 The call returns a structure with four elements. The first
805 three (C<major>, C<minor> and C<release>) are numbers and
806 correspond to the usual version triplet. The fourth element
807 (C<extra>) is a string and is normally empty, but may be
808 used for distro-specific information.
810 To construct the original version string:
811 C<$major.$minor.$release$extra>
813 See also: L<guestfs(3)/LIBGUESTFS VERSION NUMBERS>.
815 I<Note:> Don't use this call to test for availability
816 of features. In enterprise distributions we backport
817 features from later versions into earlier versions,
818 making this an unreliable way to test for features.
819 Use C<guestfs_available> instead.");
821 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
822 [InitNone, Always, TestOutputTrue (
823 [["set_selinux"; "true"];
825 "set SELinux enabled or disabled at appliance boot",
827 This sets the selinux flag that is passed to the appliance
828 at boot time. The default is C<selinux=0> (disabled).
830 Note that if SELinux is enabled, it is always in
831 Permissive mode (C<enforcing=0>).
833 For more information on the architecture of libguestfs,
834 see L<guestfs(3)>.");
836 ("get_selinux", (RBool "selinux", []), -1, [],
838 "get SELinux enabled flag",
840 This returns the current setting of the selinux flag which
841 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
843 For more information on the architecture of libguestfs,
844 see L<guestfs(3)>.");
846 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
847 [InitNone, Always, TestOutputFalse (
848 [["set_trace"; "false"];
850 "enable or disable command traces",
852 If the command trace flag is set to 1, then commands are
853 printed on stdout before they are executed in a format
854 which is very similar to the one used by guestfish. In
855 other words, you can run a program with this enabled, and
856 you will get out a script which you can feed to guestfish
857 to perform the same set of actions.
859 If you want to trace C API calls into libguestfs (and
860 other libraries) then possibly a better way is to use
861 the external ltrace(1) command.
863 Command traces are disabled unless the environment variable
864 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
866 ("get_trace", (RBool "trace", []), -1, [],
868 "get command trace enabled flag",
870 Return the command trace flag.");
872 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
873 [InitNone, Always, TestOutputFalse (
874 [["set_direct"; "false"];
876 "enable or disable direct appliance mode",
878 If the direct appliance mode flag is enabled, then stdin and
879 stdout are passed directly through to the appliance once it
882 One consequence of this is that log messages aren't caught
883 by the library and handled by C<guestfs_set_log_message_callback>,
884 but go straight to stdout.
886 You probably don't want to use this unless you know what you
889 The default is disabled.");
891 ("get_direct", (RBool "direct", []), -1, [],
893 "get direct appliance mode flag",
895 Return the direct appliance mode flag.");
897 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
898 [InitNone, Always, TestOutputTrue (
899 [["set_recovery_proc"; "true"];
900 ["get_recovery_proc"]])],
901 "enable or disable the recovery process",
903 If this is called with the parameter C<false> then
904 C<guestfs_launch> does not create a recovery process. The
905 purpose of the recovery process is to stop runaway qemu
906 processes in the case where the main program aborts abruptly.
908 This only has any effect if called before C<guestfs_launch>,
909 and the default is true.
911 About the only time when you would want to disable this is
912 if the main process will fork itself into the background
913 (\"daemonize\" itself). In this case the recovery process
914 thinks that the main program has disappeared and so kills
915 qemu, which is not very helpful.");
917 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
919 "get recovery process enabled flag",
921 Return the recovery process enabled flag.");
923 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
925 "add a drive specifying the QEMU block emulation to use",
927 This is the same as C<guestfs_add_drive> but it allows you
928 to specify the QEMU interface emulation to use at run time.");
930 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
932 "add a drive read-only specifying the QEMU block emulation to use",
934 This is the same as C<guestfs_add_drive_ro> but it allows you
935 to specify the QEMU interface emulation to use at run time.");
939 (* daemon_functions are any functions which cause some action
940 * to take place in the daemon.
943 let daemon_functions = [
944 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
945 [InitEmpty, Always, TestOutput (
946 [["part_disk"; "/dev/sda"; "mbr"];
947 ["mkfs"; "ext2"; "/dev/sda1"];
948 ["mount"; "/dev/sda1"; "/"];
949 ["write"; "/new"; "new file contents"];
950 ["cat"; "/new"]], "new file contents")],
951 "mount a guest disk at a position in the filesystem",
953 Mount a guest disk at a position in the filesystem. Block devices
954 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
955 the guest. If those block devices contain partitions, they will have
956 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
959 The rules are the same as for L<mount(2)>: A filesystem must
960 first be mounted on C</> before others can be mounted. Other
961 filesystems can only be mounted on directories which already
964 The mounted filesystem is writable, if we have sufficient permissions
965 on the underlying device.
968 When you use this call, the filesystem options C<sync> and C<noatime>
969 are set implicitly. This was originally done because we thought it
970 would improve reliability, but it turns out that I<-o sync> has a
971 very large negative performance impact and negligible effect on
972 reliability. Therefore we recommend that you avoid using
973 C<guestfs_mount> in any code that needs performance, and instead
974 use C<guestfs_mount_options> (use an empty string for the first
975 parameter if you don't want any options).");
977 ("sync", (RErr, []), 2, [],
978 [ InitEmpty, Always, TestRun [["sync"]]],
979 "sync disks, writes are flushed through to the disk image",
981 This syncs the disk, so that any writes are flushed through to the
982 underlying disk image.
984 You should always call this if you have modified a disk image, before
985 closing the handle.");
987 ("touch", (RErr, [Pathname "path"]), 3, [],
988 [InitBasicFS, Always, TestOutputTrue (
990 ["exists"; "/new"]])],
991 "update file timestamps or create a new file",
993 Touch acts like the L<touch(1)> command. It can be used to
994 update the timestamps on a file, or, if the file does not exist,
995 to create a new zero-length file.
997 This command only works on regular files, and will fail on other
998 file types such as directories, symbolic links, block special etc.");
1000 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
1001 [InitISOFS, Always, TestOutput (
1002 [["cat"; "/known-2"]], "abcdef\n")],
1003 "list the contents of a file",
1005 Return the contents of the file named C<path>.
1007 Note that this function cannot correctly handle binary files
1008 (specifically, files containing C<\\0> character which is treated
1009 as end of string). For those you need to use the C<guestfs_read_file>
1010 or C<guestfs_download> functions which have a more complex interface.");
1012 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1013 [], (* XXX Tricky to test because it depends on the exact format
1014 * of the 'ls -l' command, which changes between F10 and F11.
1016 "list the files in a directory (long format)",
1018 List the files in C<directory> (relative to the root directory,
1019 there is no cwd) in the format of 'ls -la'.
1021 This command is mostly useful for interactive sessions. It
1022 is I<not> intended that you try to parse the output string.");
1024 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1025 [InitBasicFS, Always, TestOutputList (
1027 ["touch"; "/newer"];
1028 ["touch"; "/newest"];
1029 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1030 "list the files in a directory",
1032 List the files in C<directory> (relative to the root directory,
1033 there is no cwd). The '.' and '..' entries are not returned, but
1034 hidden files are shown.
1036 This command is mostly useful for interactive sessions. Programs
1037 should probably use C<guestfs_readdir> instead.");
1039 ("list_devices", (RStringList "devices", []), 7, [],
1040 [InitEmpty, Always, TestOutputListOfDevices (
1041 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1042 "list the block devices",
1044 List all the block devices.
1046 The full block device names are returned, eg. C</dev/sda>");
1048 ("list_partitions", (RStringList "partitions", []), 8, [],
1049 [InitBasicFS, Always, TestOutputListOfDevices (
1050 [["list_partitions"]], ["/dev/sda1"]);
1051 InitEmpty, Always, TestOutputListOfDevices (
1052 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1053 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1054 "list the partitions",
1056 List all the partitions detected on all block devices.
1058 The full partition device names are returned, eg. C</dev/sda1>
1060 This does not return logical volumes. For that you will need to
1061 call C<guestfs_lvs>.");
1063 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1064 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1065 [["pvs"]], ["/dev/sda1"]);
1066 InitEmpty, Always, TestOutputListOfDevices (
1067 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1068 ["pvcreate"; "/dev/sda1"];
1069 ["pvcreate"; "/dev/sda2"];
1070 ["pvcreate"; "/dev/sda3"];
1071 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1072 "list the LVM physical volumes (PVs)",
1074 List all the physical volumes detected. This is the equivalent
1075 of the L<pvs(8)> command.
1077 This returns a list of just the device names that contain
1078 PVs (eg. C</dev/sda2>).
1080 See also C<guestfs_pvs_full>.");
1082 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1083 [InitBasicFSonLVM, Always, TestOutputList (
1085 InitEmpty, Always, TestOutputList (
1086 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1087 ["pvcreate"; "/dev/sda1"];
1088 ["pvcreate"; "/dev/sda2"];
1089 ["pvcreate"; "/dev/sda3"];
1090 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1091 ["vgcreate"; "VG2"; "/dev/sda3"];
1092 ["vgs"]], ["VG1"; "VG2"])],
1093 "list the LVM volume groups (VGs)",
1095 List all the volumes groups detected. This is the equivalent
1096 of the L<vgs(8)> command.
1098 This returns a list of just the volume group names that were
1099 detected (eg. C<VolGroup00>).
1101 See also C<guestfs_vgs_full>.");
1103 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1104 [InitBasicFSonLVM, Always, TestOutputList (
1105 [["lvs"]], ["/dev/VG/LV"]);
1106 InitEmpty, Always, TestOutputList (
1107 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1108 ["pvcreate"; "/dev/sda1"];
1109 ["pvcreate"; "/dev/sda2"];
1110 ["pvcreate"; "/dev/sda3"];
1111 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1112 ["vgcreate"; "VG2"; "/dev/sda3"];
1113 ["lvcreate"; "LV1"; "VG1"; "50"];
1114 ["lvcreate"; "LV2"; "VG1"; "50"];
1115 ["lvcreate"; "LV3"; "VG2"; "50"];
1116 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1117 "list the LVM logical volumes (LVs)",
1119 List all the logical volumes detected. This is the equivalent
1120 of the L<lvs(8)> command.
1122 This returns a list of the logical volume device names
1123 (eg. C</dev/VolGroup00/LogVol00>).
1125 See also C<guestfs_lvs_full>.");
1127 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1128 [], (* XXX how to test? *)
1129 "list the LVM physical volumes (PVs)",
1131 List all the physical volumes detected. This is the equivalent
1132 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1134 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1135 [], (* XXX how to test? *)
1136 "list the LVM volume groups (VGs)",
1138 List all the volumes groups detected. This is the equivalent
1139 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1141 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1142 [], (* XXX how to test? *)
1143 "list the LVM logical volumes (LVs)",
1145 List all the logical volumes detected. This is the equivalent
1146 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1148 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1149 [InitISOFS, Always, TestOutputList (
1150 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1151 InitISOFS, Always, TestOutputList (
1152 [["read_lines"; "/empty"]], [])],
1153 "read file as lines",
1155 Return the contents of the file named C<path>.
1157 The file contents are returned as a list of lines. Trailing
1158 C<LF> and C<CRLF> character sequences are I<not> returned.
1160 Note that this function cannot correctly handle binary files
1161 (specifically, files containing C<\\0> character which is treated
1162 as end of line). For those you need to use the C<guestfs_read_file>
1163 function which has a more complex interface.");
1165 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1166 [], (* XXX Augeas code needs tests. *)
1167 "create a new Augeas handle",
1169 Create a new Augeas handle for editing configuration files.
1170 If there was any previous Augeas handle associated with this
1171 guestfs session, then it is closed.
1173 You must call this before using any other C<guestfs_aug_*>
1176 C<root> is the filesystem root. C<root> must not be NULL,
1179 The flags are the same as the flags defined in
1180 E<lt>augeas.hE<gt>, the logical I<or> of the following
1185 =item C<AUG_SAVE_BACKUP> = 1
1187 Keep the original file with a C<.augsave> extension.
1189 =item C<AUG_SAVE_NEWFILE> = 2
1191 Save changes into a file with extension C<.augnew>, and
1192 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1194 =item C<AUG_TYPE_CHECK> = 4
1196 Typecheck lenses (can be expensive).
1198 =item C<AUG_NO_STDINC> = 8
1200 Do not use standard load path for modules.
1202 =item C<AUG_SAVE_NOOP> = 16
1204 Make save a no-op, just record what would have been changed.
1206 =item C<AUG_NO_LOAD> = 32
1208 Do not load the tree in C<guestfs_aug_init>.
1212 To close the handle, you can call C<guestfs_aug_close>.
1214 To find out more about Augeas, see L<http://augeas.net/>.");
1216 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1217 [], (* XXX Augeas code needs tests. *)
1218 "close the current Augeas handle",
1220 Close the current Augeas handle and free up any resources
1221 used by it. After calling this, you have to call
1222 C<guestfs_aug_init> again before you can use any other
1223 Augeas functions.");
1225 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1226 [], (* XXX Augeas code needs tests. *)
1227 "define an Augeas variable",
1229 Defines an Augeas variable C<name> whose value is the result
1230 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1233 On success this returns the number of nodes in C<expr>, or
1234 C<0> if C<expr> evaluates to something which is not a nodeset.");
1236 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1237 [], (* XXX Augeas code needs tests. *)
1238 "define an Augeas node",
1240 Defines a variable C<name> whose value is the result of
1243 If C<expr> evaluates to an empty nodeset, a node is created,
1244 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1245 C<name> will be the nodeset containing that single node.
1247 On success this returns a pair containing the
1248 number of nodes in the nodeset, and a boolean flag
1249 if a node was created.");
1251 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1252 [], (* XXX Augeas code needs tests. *)
1253 "look up the value of an Augeas path",
1255 Look up the value associated with C<path>. If C<path>
1256 matches exactly one node, the C<value> is returned.");
1258 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1259 [], (* XXX Augeas code needs tests. *)
1260 "set Augeas path to value",
1262 Set the value associated with C<path> to C<val>.
1264 In the Augeas API, it is possible to clear a node by setting
1265 the value to NULL. Due to an oversight in the libguestfs API
1266 you cannot do that with this call. Instead you must use the
1267 C<guestfs_aug_clear> call.");
1269 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1270 [], (* XXX Augeas code needs tests. *)
1271 "insert a sibling Augeas node",
1273 Create a new sibling C<label> for C<path>, inserting it into
1274 the tree before or after C<path> (depending on the boolean
1277 C<path> must match exactly one existing node in the tree, and
1278 C<label> must be a label, ie. not contain C</>, C<*> or end
1279 with a bracketed index C<[N]>.");
1281 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1282 [], (* XXX Augeas code needs tests. *)
1283 "remove an Augeas path",
1285 Remove C<path> and all of its children.
1287 On success this returns the number of entries which were removed.");
1289 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1290 [], (* XXX Augeas code needs tests. *)
1293 Move the node C<src> to C<dest>. C<src> must match exactly
1294 one node. C<dest> is overwritten if it exists.");
1296 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1297 [], (* XXX Augeas code needs tests. *)
1298 "return Augeas nodes which match augpath",
1300 Returns a list of paths which match the path expression C<path>.
1301 The returned paths are sufficiently qualified so that they match
1302 exactly one node in the current tree.");
1304 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1305 [], (* XXX Augeas code needs tests. *)
1306 "write all pending Augeas changes to disk",
1308 This writes all pending changes to disk.
1310 The flags which were passed to C<guestfs_aug_init> affect exactly
1311 how files are saved.");
1313 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1314 [], (* XXX Augeas code needs tests. *)
1315 "load files into the tree",
1317 Load files into the tree.
1319 See C<aug_load> in the Augeas documentation for the full gory
1322 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1323 [], (* XXX Augeas code needs tests. *)
1324 "list Augeas nodes under augpath",
1326 This is just a shortcut for listing C<guestfs_aug_match>
1327 C<path/*> and sorting the resulting nodes into alphabetical order.");
1329 ("rm", (RErr, [Pathname "path"]), 29, [],
1330 [InitBasicFS, Always, TestRun
1333 InitBasicFS, Always, TestLastFail
1335 InitBasicFS, Always, TestLastFail
1340 Remove the single file C<path>.");
1342 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1343 [InitBasicFS, Always, TestRun
1346 InitBasicFS, Always, TestLastFail
1347 [["rmdir"; "/new"]];
1348 InitBasicFS, Always, TestLastFail
1350 ["rmdir"; "/new"]]],
1351 "remove a directory",
1353 Remove the single directory C<path>.");
1355 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1356 [InitBasicFS, Always, TestOutputFalse
1358 ["mkdir"; "/new/foo"];
1359 ["touch"; "/new/foo/bar"];
1361 ["exists"; "/new"]]],
1362 "remove a file or directory recursively",
1364 Remove the file or directory C<path>, recursively removing the
1365 contents if its a directory. This is like the C<rm -rf> shell
1368 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1369 [InitBasicFS, Always, TestOutputTrue
1371 ["is_dir"; "/new"]];
1372 InitBasicFS, Always, TestLastFail
1373 [["mkdir"; "/new/foo/bar"]]],
1374 "create a directory",
1376 Create a directory named C<path>.");
1378 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1379 [InitBasicFS, Always, TestOutputTrue
1380 [["mkdir_p"; "/new/foo/bar"];
1381 ["is_dir"; "/new/foo/bar"]];
1382 InitBasicFS, Always, TestOutputTrue
1383 [["mkdir_p"; "/new/foo/bar"];
1384 ["is_dir"; "/new/foo"]];
1385 InitBasicFS, Always, TestOutputTrue
1386 [["mkdir_p"; "/new/foo/bar"];
1387 ["is_dir"; "/new"]];
1388 (* Regression tests for RHBZ#503133: *)
1389 InitBasicFS, Always, TestRun
1391 ["mkdir_p"; "/new"]];
1392 InitBasicFS, Always, TestLastFail
1394 ["mkdir_p"; "/new"]]],
1395 "create a directory and parents",
1397 Create a directory named C<path>, creating any parent directories
1398 as necessary. This is like the C<mkdir -p> shell command.");
1400 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1401 [], (* XXX Need stat command to test *)
1404 Change the mode (permissions) of C<path> to C<mode>. Only
1405 numeric modes are supported.
1407 I<Note>: When using this command from guestfish, C<mode>
1408 by default would be decimal, unless you prefix it with
1409 C<0> to get octal, ie. use C<0700> not C<700>.
1411 The mode actually set is affected by the umask.");
1413 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1414 [], (* XXX Need stat command to test *)
1415 "change file owner and group",
1417 Change the file owner to C<owner> and group to C<group>.
1419 Only numeric uid and gid are supported. If you want to use
1420 names, you will need to locate and parse the password file
1421 yourself (Augeas support makes this relatively easy).");
1423 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1424 [InitISOFS, Always, TestOutputTrue (
1425 [["exists"; "/empty"]]);
1426 InitISOFS, Always, TestOutputTrue (
1427 [["exists"; "/directory"]])],
1428 "test if file or directory exists",
1430 This returns C<true> if and only if there is a file, directory
1431 (or anything) with the given C<path> name.
1433 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1435 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1436 [InitISOFS, Always, TestOutputTrue (
1437 [["is_file"; "/known-1"]]);
1438 InitISOFS, Always, TestOutputFalse (
1439 [["is_file"; "/directory"]])],
1440 "test if file exists",
1442 This returns C<true> if and only if there is a file
1443 with the given C<path> name. Note that it returns false for
1444 other objects like directories.
1446 See also C<guestfs_stat>.");
1448 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1449 [InitISOFS, Always, TestOutputFalse (
1450 [["is_dir"; "/known-3"]]);
1451 InitISOFS, Always, TestOutputTrue (
1452 [["is_dir"; "/directory"]])],
1453 "test if file exists",
1455 This returns C<true> if and only if there is a directory
1456 with the given C<path> name. Note that it returns false for
1457 other objects like files.
1459 See also C<guestfs_stat>.");
1461 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1462 [InitEmpty, Always, TestOutputListOfDevices (
1463 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1464 ["pvcreate"; "/dev/sda1"];
1465 ["pvcreate"; "/dev/sda2"];
1466 ["pvcreate"; "/dev/sda3"];
1467 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1468 "create an LVM physical volume",
1470 This creates an LVM physical volume on the named C<device>,
1471 where C<device> should usually be a partition name such
1474 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1475 [InitEmpty, Always, TestOutputList (
1476 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1477 ["pvcreate"; "/dev/sda1"];
1478 ["pvcreate"; "/dev/sda2"];
1479 ["pvcreate"; "/dev/sda3"];
1480 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1481 ["vgcreate"; "VG2"; "/dev/sda3"];
1482 ["vgs"]], ["VG1"; "VG2"])],
1483 "create an LVM volume group",
1485 This creates an LVM volume group called C<volgroup>
1486 from the non-empty list of physical volumes C<physvols>.");
1488 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1489 [InitEmpty, Always, TestOutputList (
1490 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1491 ["pvcreate"; "/dev/sda1"];
1492 ["pvcreate"; "/dev/sda2"];
1493 ["pvcreate"; "/dev/sda3"];
1494 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1495 ["vgcreate"; "VG2"; "/dev/sda3"];
1496 ["lvcreate"; "LV1"; "VG1"; "50"];
1497 ["lvcreate"; "LV2"; "VG1"; "50"];
1498 ["lvcreate"; "LV3"; "VG2"; "50"];
1499 ["lvcreate"; "LV4"; "VG2"; "50"];
1500 ["lvcreate"; "LV5"; "VG2"; "50"];
1502 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1503 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1504 "create an LVM logical volume",
1506 This creates an LVM logical volume called C<logvol>
1507 on the volume group C<volgroup>, with C<size> megabytes.");
1509 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1510 [InitEmpty, Always, TestOutput (
1511 [["part_disk"; "/dev/sda"; "mbr"];
1512 ["mkfs"; "ext2"; "/dev/sda1"];
1513 ["mount_options"; ""; "/dev/sda1"; "/"];
1514 ["write"; "/new"; "new file contents"];
1515 ["cat"; "/new"]], "new file contents")],
1516 "make a filesystem",
1518 This creates a filesystem on C<device> (usually a partition
1519 or LVM logical volume). The filesystem type is C<fstype>, for
1522 ("sfdisk", (RErr, [Device "device";
1523 Int "cyls"; Int "heads"; Int "sectors";
1524 StringList "lines"]), 43, [DangerWillRobinson],
1526 "create partitions on a block device",
1528 This is a direct interface to the L<sfdisk(8)> program for creating
1529 partitions on block devices.
1531 C<device> should be a block device, for example C</dev/sda>.
1533 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1534 and sectors on the device, which are passed directly to sfdisk as
1535 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1536 of these, then the corresponding parameter is omitted. Usually for
1537 'large' disks, you can just pass C<0> for these, but for small
1538 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1539 out the right geometry and you will need to tell it.
1541 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1542 information refer to the L<sfdisk(8)> manpage.
1544 To create a single partition occupying the whole disk, you would
1545 pass C<lines> as a single element list, when the single element being
1546 the string C<,> (comma).
1548 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1549 C<guestfs_part_init>");
1551 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1552 (* Regression test for RHBZ#597135. *)
1553 [InitBasicFS, Always, TestLastFail
1554 [["write_file"; "/new"; "abc"; "10000"]]],
1557 This call creates a file called C<path>. The contents of the
1558 file is the string C<content> (which can contain any 8 bit data),
1559 with length C<size>.
1561 As a special case, if C<size> is C<0>
1562 then the length is calculated using C<strlen> (so in this case
1563 the content cannot contain embedded ASCII NULs).
1565 I<NB.> Owing to a bug, writing content containing ASCII NUL
1566 characters does I<not> work, even if the length is specified.");
1568 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1569 [InitEmpty, Always, TestOutputListOfDevices (
1570 [["part_disk"; "/dev/sda"; "mbr"];
1571 ["mkfs"; "ext2"; "/dev/sda1"];
1572 ["mount_options"; ""; "/dev/sda1"; "/"];
1573 ["mounts"]], ["/dev/sda1"]);
1574 InitEmpty, Always, TestOutputList (
1575 [["part_disk"; "/dev/sda"; "mbr"];
1576 ["mkfs"; "ext2"; "/dev/sda1"];
1577 ["mount_options"; ""; "/dev/sda1"; "/"];
1580 "unmount a filesystem",
1582 This unmounts the given filesystem. The filesystem may be
1583 specified either by its mountpoint (path) or the device which
1584 contains the filesystem.");
1586 ("mounts", (RStringList "devices", []), 46, [],
1587 [InitBasicFS, Always, TestOutputListOfDevices (
1588 [["mounts"]], ["/dev/sda1"])],
1589 "show mounted filesystems",
1591 This returns the list of currently mounted filesystems. It returns
1592 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1594 Some internal mounts are not shown.
1596 See also: C<guestfs_mountpoints>");
1598 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1599 [InitBasicFS, Always, TestOutputList (
1602 (* check that umount_all can unmount nested mounts correctly: *)
1603 InitEmpty, Always, TestOutputList (
1604 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1605 ["mkfs"; "ext2"; "/dev/sda1"];
1606 ["mkfs"; "ext2"; "/dev/sda2"];
1607 ["mkfs"; "ext2"; "/dev/sda3"];
1608 ["mount_options"; ""; "/dev/sda1"; "/"];
1610 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1611 ["mkdir"; "/mp1/mp2"];
1612 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1613 ["mkdir"; "/mp1/mp2/mp3"];
1616 "unmount all filesystems",
1618 This unmounts all mounted filesystems.
1620 Some internal mounts are not unmounted by this call.");
1622 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1624 "remove all LVM LVs, VGs and PVs",
1626 This command removes all LVM logical volumes, volume groups
1627 and physical volumes.");
1629 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1630 [InitISOFS, Always, TestOutput (
1631 [["file"; "/empty"]], "empty");
1632 InitISOFS, Always, TestOutput (
1633 [["file"; "/known-1"]], "ASCII text");
1634 InitISOFS, Always, TestLastFail (
1635 [["file"; "/notexists"]]);
1636 InitISOFS, Always, TestOutput (
1637 [["file"; "/abssymlink"]], "symbolic link");
1638 InitISOFS, Always, TestOutput (
1639 [["file"; "/directory"]], "directory")],
1640 "determine file type",
1642 This call uses the standard L<file(1)> command to determine
1643 the type or contents of the file.
1645 This call will also transparently look inside various types
1648 The exact command which runs is C<file -zb path>. Note in
1649 particular that the filename is not prepended to the output
1652 This command can also be used on C</dev/> devices
1653 (and partitions, LV names). You can for example use this
1654 to determine if a device contains a filesystem, although
1655 it's usually better to use C<guestfs_vfs_type>.
1657 If the C<path> does not begin with C</dev/> then
1658 this command only works for the content of regular files.
1659 For other file types (directory, symbolic link etc) it
1660 will just return the string C<directory> etc.");
1662 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1663 [InitBasicFS, Always, TestOutput (
1664 [["upload"; "test-command"; "/test-command"];
1665 ["chmod"; "0o755"; "/test-command"];
1666 ["command"; "/test-command 1"]], "Result1");
1667 InitBasicFS, Always, TestOutput (
1668 [["upload"; "test-command"; "/test-command"];
1669 ["chmod"; "0o755"; "/test-command"];
1670 ["command"; "/test-command 2"]], "Result2\n");
1671 InitBasicFS, Always, TestOutput (
1672 [["upload"; "test-command"; "/test-command"];
1673 ["chmod"; "0o755"; "/test-command"];
1674 ["command"; "/test-command 3"]], "\nResult3");
1675 InitBasicFS, Always, TestOutput (
1676 [["upload"; "test-command"; "/test-command"];
1677 ["chmod"; "0o755"; "/test-command"];
1678 ["command"; "/test-command 4"]], "\nResult4\n");
1679 InitBasicFS, Always, TestOutput (
1680 [["upload"; "test-command"; "/test-command"];
1681 ["chmod"; "0o755"; "/test-command"];
1682 ["command"; "/test-command 5"]], "\nResult5\n\n");
1683 InitBasicFS, Always, TestOutput (
1684 [["upload"; "test-command"; "/test-command"];
1685 ["chmod"; "0o755"; "/test-command"];
1686 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1687 InitBasicFS, Always, TestOutput (
1688 [["upload"; "test-command"; "/test-command"];
1689 ["chmod"; "0o755"; "/test-command"];
1690 ["command"; "/test-command 7"]], "");
1691 InitBasicFS, Always, TestOutput (
1692 [["upload"; "test-command"; "/test-command"];
1693 ["chmod"; "0o755"; "/test-command"];
1694 ["command"; "/test-command 8"]], "\n");
1695 InitBasicFS, Always, TestOutput (
1696 [["upload"; "test-command"; "/test-command"];
1697 ["chmod"; "0o755"; "/test-command"];
1698 ["command"; "/test-command 9"]], "\n\n");
1699 InitBasicFS, Always, TestOutput (
1700 [["upload"; "test-command"; "/test-command"];
1701 ["chmod"; "0o755"; "/test-command"];
1702 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1703 InitBasicFS, Always, TestOutput (
1704 [["upload"; "test-command"; "/test-command"];
1705 ["chmod"; "0o755"; "/test-command"];
1706 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1707 InitBasicFS, Always, TestLastFail (
1708 [["upload"; "test-command"; "/test-command"];
1709 ["chmod"; "0o755"; "/test-command"];
1710 ["command"; "/test-command"]])],
1711 "run a command from the guest filesystem",
1713 This call runs a command from the guest filesystem. The
1714 filesystem must be mounted, and must contain a compatible
1715 operating system (ie. something Linux, with the same
1716 or compatible processor architecture).
1718 The single parameter is an argv-style list of arguments.
1719 The first element is the name of the program to run.
1720 Subsequent elements are parameters. The list must be
1721 non-empty (ie. must contain a program name). Note that
1722 the command runs directly, and is I<not> invoked via
1723 the shell (see C<guestfs_sh>).
1725 The return value is anything printed to I<stdout> by
1728 If the command returns a non-zero exit status, then
1729 this function returns an error message. The error message
1730 string is the content of I<stderr> from the command.
1732 The C<$PATH> environment variable will contain at least
1733 C</usr/bin> and C</bin>. If you require a program from
1734 another location, you should provide the full path in the
1737 Shared libraries and data files required by the program
1738 must be available on filesystems which are mounted in the
1739 correct places. It is the caller's responsibility to ensure
1740 all filesystems that are needed are mounted at the right
1743 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1744 [InitBasicFS, Always, TestOutputList (
1745 [["upload"; "test-command"; "/test-command"];
1746 ["chmod"; "0o755"; "/test-command"];
1747 ["command_lines"; "/test-command 1"]], ["Result1"]);
1748 InitBasicFS, Always, TestOutputList (
1749 [["upload"; "test-command"; "/test-command"];
1750 ["chmod"; "0o755"; "/test-command"];
1751 ["command_lines"; "/test-command 2"]], ["Result2"]);
1752 InitBasicFS, Always, TestOutputList (
1753 [["upload"; "test-command"; "/test-command"];
1754 ["chmod"; "0o755"; "/test-command"];
1755 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1756 InitBasicFS, Always, TestOutputList (
1757 [["upload"; "test-command"; "/test-command"];
1758 ["chmod"; "0o755"; "/test-command"];
1759 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1760 InitBasicFS, Always, TestOutputList (
1761 [["upload"; "test-command"; "/test-command"];
1762 ["chmod"; "0o755"; "/test-command"];
1763 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1764 InitBasicFS, Always, TestOutputList (
1765 [["upload"; "test-command"; "/test-command"];
1766 ["chmod"; "0o755"; "/test-command"];
1767 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1768 InitBasicFS, Always, TestOutputList (
1769 [["upload"; "test-command"; "/test-command"];
1770 ["chmod"; "0o755"; "/test-command"];
1771 ["command_lines"; "/test-command 7"]], []);
1772 InitBasicFS, Always, TestOutputList (
1773 [["upload"; "test-command"; "/test-command"];
1774 ["chmod"; "0o755"; "/test-command"];
1775 ["command_lines"; "/test-command 8"]], [""]);
1776 InitBasicFS, Always, TestOutputList (
1777 [["upload"; "test-command"; "/test-command"];
1778 ["chmod"; "0o755"; "/test-command"];
1779 ["command_lines"; "/test-command 9"]], ["";""]);
1780 InitBasicFS, Always, TestOutputList (
1781 [["upload"; "test-command"; "/test-command"];
1782 ["chmod"; "0o755"; "/test-command"];
1783 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1784 InitBasicFS, Always, TestOutputList (
1785 [["upload"; "test-command"; "/test-command"];
1786 ["chmod"; "0o755"; "/test-command"];
1787 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1788 "run a command, returning lines",
1790 This is the same as C<guestfs_command>, but splits the
1791 result into a list of lines.
1793 See also: C<guestfs_sh_lines>");
1795 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1796 [InitISOFS, Always, TestOutputStruct (
1797 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1798 "get file information",
1800 Returns file information for the given C<path>.
1802 This is the same as the C<stat(2)> system call.");
1804 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1805 [InitISOFS, Always, TestOutputStruct (
1806 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1807 "get file information for a symbolic link",
1809 Returns file information for the given C<path>.
1811 This is the same as C<guestfs_stat> except that if C<path>
1812 is a symbolic link, then the link is stat-ed, not the file it
1815 This is the same as the C<lstat(2)> system call.");
1817 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1818 [InitISOFS, Always, TestOutputStruct (
1819 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1820 "get file system statistics",
1822 Returns file system statistics for any mounted file system.
1823 C<path> should be a file or directory in the mounted file system
1824 (typically it is the mount point itself, but it doesn't need to be).
1826 This is the same as the C<statvfs(2)> system call.");
1828 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1830 "get ext2/ext3/ext4 superblock details",
1832 This returns the contents of the ext2, ext3 or ext4 filesystem
1833 superblock on C<device>.
1835 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1836 manpage for more details. The list of fields returned isn't
1837 clearly defined, and depends on both the version of C<tune2fs>
1838 that libguestfs was built against, and the filesystem itself.");
1840 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1841 [InitEmpty, Always, TestOutputTrue (
1842 [["blockdev_setro"; "/dev/sda"];
1843 ["blockdev_getro"; "/dev/sda"]])],
1844 "set block device to read-only",
1846 Sets the block device named C<device> to read-only.
1848 This uses the L<blockdev(8)> command.");
1850 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1851 [InitEmpty, Always, TestOutputFalse (
1852 [["blockdev_setrw"; "/dev/sda"];
1853 ["blockdev_getro"; "/dev/sda"]])],
1854 "set block device to read-write",
1856 Sets the block device named C<device> to read-write.
1858 This uses the L<blockdev(8)> command.");
1860 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1861 [InitEmpty, Always, TestOutputTrue (
1862 [["blockdev_setro"; "/dev/sda"];
1863 ["blockdev_getro"; "/dev/sda"]])],
1864 "is block device set to read-only",
1866 Returns a boolean indicating if the block device is read-only
1867 (true if read-only, false if not).
1869 This uses the L<blockdev(8)> command.");
1871 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1872 [InitEmpty, Always, TestOutputInt (
1873 [["blockdev_getss"; "/dev/sda"]], 512)],
1874 "get sectorsize of block device",
1876 This returns the size of sectors on a block device.
1877 Usually 512, but can be larger for modern devices.
1879 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1882 This uses the L<blockdev(8)> command.");
1884 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1885 [InitEmpty, Always, TestOutputInt (
1886 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1887 "get blocksize of block device",
1889 This returns the block size of a device.
1891 (Note this is different from both I<size in blocks> and
1892 I<filesystem block size>).
1894 This uses the L<blockdev(8)> command.");
1896 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1898 "set blocksize of block device",
1900 This sets the block size of a device.
1902 (Note this is different from both I<size in blocks> and
1903 I<filesystem block size>).
1905 This uses the L<blockdev(8)> command.");
1907 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1908 [InitEmpty, Always, TestOutputInt (
1909 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1910 "get total size of device in 512-byte sectors",
1912 This returns the size of the device in units of 512-byte sectors
1913 (even if the sectorsize isn't 512 bytes ... weird).
1915 See also C<guestfs_blockdev_getss> for the real sector size of
1916 the device, and C<guestfs_blockdev_getsize64> for the more
1917 useful I<size in bytes>.
1919 This uses the L<blockdev(8)> command.");
1921 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1922 [InitEmpty, Always, TestOutputInt (
1923 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1924 "get total size of device in bytes",
1926 This returns the size of the device in bytes.
1928 See also C<guestfs_blockdev_getsz>.
1930 This uses the L<blockdev(8)> command.");
1932 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1933 [InitEmpty, Always, TestRun
1934 [["blockdev_flushbufs"; "/dev/sda"]]],
1935 "flush device buffers",
1937 This tells the kernel to flush internal buffers associated
1940 This uses the L<blockdev(8)> command.");
1942 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1943 [InitEmpty, Always, TestRun
1944 [["blockdev_rereadpt"; "/dev/sda"]]],
1945 "reread partition table",
1947 Reread the partition table on C<device>.
1949 This uses the L<blockdev(8)> command.");
1951 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1952 [InitBasicFS, Always, TestOutput (
1953 (* Pick a file from cwd which isn't likely to change. *)
1954 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1955 ["checksum"; "md5"; "/COPYING.LIB"]],
1956 Digest.to_hex (Digest.file "COPYING.LIB"))],
1957 "upload a file from the local machine",
1959 Upload local file C<filename> to C<remotefilename> on the
1962 C<filename> can also be a named pipe.
1964 See also C<guestfs_download>.");
1966 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1967 [InitBasicFS, Always, TestOutput (
1968 (* Pick a file from cwd which isn't likely to change. *)
1969 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1970 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1971 ["upload"; "testdownload.tmp"; "/upload"];
1972 ["checksum"; "md5"; "/upload"]],
1973 Digest.to_hex (Digest.file "COPYING.LIB"))],
1974 "download a file to the local machine",
1976 Download file C<remotefilename> and save it as C<filename>
1977 on the local machine.
1979 C<filename> can also be a named pipe.
1981 See also C<guestfs_upload>, C<guestfs_cat>.");
1983 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1984 [InitISOFS, Always, TestOutput (
1985 [["checksum"; "crc"; "/known-3"]], "2891671662");
1986 InitISOFS, Always, TestLastFail (
1987 [["checksum"; "crc"; "/notexists"]]);
1988 InitISOFS, Always, TestOutput (
1989 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1990 InitISOFS, Always, TestOutput (
1991 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1992 InitISOFS, Always, TestOutput (
1993 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1994 InitISOFS, Always, TestOutput (
1995 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1996 InitISOFS, Always, TestOutput (
1997 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1998 InitISOFS, Always, TestOutput (
1999 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
2000 (* Test for RHBZ#579608, absolute symbolic links. *)
2001 InitISOFS, Always, TestOutput (
2002 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
2003 "compute MD5, SHAx or CRC checksum of file",
2005 This call computes the MD5, SHAx or CRC checksum of the
2008 The type of checksum to compute is given by the C<csumtype>
2009 parameter which must have one of the following values:
2015 Compute the cyclic redundancy check (CRC) specified by POSIX
2016 for the C<cksum> command.
2020 Compute the MD5 hash (using the C<md5sum> program).
2024 Compute the SHA1 hash (using the C<sha1sum> program).
2028 Compute the SHA224 hash (using the C<sha224sum> program).
2032 Compute the SHA256 hash (using the C<sha256sum> program).
2036 Compute the SHA384 hash (using the C<sha384sum> program).
2040 Compute the SHA512 hash (using the C<sha512sum> program).
2044 The checksum is returned as a printable string.
2046 To get the checksum for a device, use C<guestfs_checksum_device>.
2048 To get the checksums for many files, use C<guestfs_checksums_out>.");
2050 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2051 [InitBasicFS, Always, TestOutput (
2052 [["tar_in"; "../images/helloworld.tar"; "/"];
2053 ["cat"; "/hello"]], "hello\n")],
2054 "unpack tarfile to directory",
2056 This command uploads and unpacks local file C<tarfile> (an
2057 I<uncompressed> tar file) into C<directory>.
2059 To upload a compressed tarball, use C<guestfs_tgz_in>
2060 or C<guestfs_txz_in>.");
2062 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2064 "pack directory into tarfile",
2066 This command packs the contents of C<directory> and downloads
2067 it to local file C<tarfile>.
2069 To download a compressed tarball, use C<guestfs_tgz_out>
2070 or C<guestfs_txz_out>.");
2072 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2073 [InitBasicFS, Always, TestOutput (
2074 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2075 ["cat"; "/hello"]], "hello\n")],
2076 "unpack compressed tarball to directory",
2078 This command uploads and unpacks local file C<tarball> (a
2079 I<gzip compressed> tar file) into C<directory>.
2081 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2083 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2085 "pack directory into compressed tarball",
2087 This command packs the contents of C<directory> and downloads
2088 it to local file C<tarball>.
2090 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2092 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2093 [InitBasicFS, Always, TestLastFail (
2095 ["mount_ro"; "/dev/sda1"; "/"];
2096 ["touch"; "/new"]]);
2097 InitBasicFS, Always, TestOutput (
2098 [["write"; "/new"; "data"];
2100 ["mount_ro"; "/dev/sda1"; "/"];
2101 ["cat"; "/new"]], "data")],
2102 "mount a guest disk, read-only",
2104 This is the same as the C<guestfs_mount> command, but it
2105 mounts the filesystem with the read-only (I<-o ro>) flag.");
2107 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2109 "mount a guest disk with mount options",
2111 This is the same as the C<guestfs_mount> command, but it
2112 allows you to set the mount options as for the
2113 L<mount(8)> I<-o> flag.
2115 If the C<options> parameter is an empty string, then
2116 no options are passed (all options default to whatever
2117 the filesystem uses).");
2119 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2121 "mount a guest disk with mount options and vfstype",
2123 This is the same as the C<guestfs_mount> command, but it
2124 allows you to set both the mount options and the vfstype
2125 as for the L<mount(8)> I<-o> and I<-t> flags.");
2127 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2129 "debugging and internals",
2131 The C<guestfs_debug> command exposes some internals of
2132 C<guestfsd> (the guestfs daemon) that runs inside the
2135 There is no comprehensive help for this command. You have
2136 to look at the file C<daemon/debug.c> in the libguestfs source
2137 to find out what you can do.");
2139 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2140 [InitEmpty, Always, TestOutputList (
2141 [["part_disk"; "/dev/sda"; "mbr"];
2142 ["pvcreate"; "/dev/sda1"];
2143 ["vgcreate"; "VG"; "/dev/sda1"];
2144 ["lvcreate"; "LV1"; "VG"; "50"];
2145 ["lvcreate"; "LV2"; "VG"; "50"];
2146 ["lvremove"; "/dev/VG/LV1"];
2147 ["lvs"]], ["/dev/VG/LV2"]);
2148 InitEmpty, Always, TestOutputList (
2149 [["part_disk"; "/dev/sda"; "mbr"];
2150 ["pvcreate"; "/dev/sda1"];
2151 ["vgcreate"; "VG"; "/dev/sda1"];
2152 ["lvcreate"; "LV1"; "VG"; "50"];
2153 ["lvcreate"; "LV2"; "VG"; "50"];
2154 ["lvremove"; "/dev/VG"];
2156 InitEmpty, Always, TestOutputList (
2157 [["part_disk"; "/dev/sda"; "mbr"];
2158 ["pvcreate"; "/dev/sda1"];
2159 ["vgcreate"; "VG"; "/dev/sda1"];
2160 ["lvcreate"; "LV1"; "VG"; "50"];
2161 ["lvcreate"; "LV2"; "VG"; "50"];
2162 ["lvremove"; "/dev/VG"];
2164 "remove an LVM logical volume",
2166 Remove an LVM logical volume C<device>, where C<device> is
2167 the path to the LV, such as C</dev/VG/LV>.
2169 You can also remove all LVs in a volume group by specifying
2170 the VG name, C</dev/VG>.");
2172 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2173 [InitEmpty, Always, TestOutputList (
2174 [["part_disk"; "/dev/sda"; "mbr"];
2175 ["pvcreate"; "/dev/sda1"];
2176 ["vgcreate"; "VG"; "/dev/sda1"];
2177 ["lvcreate"; "LV1"; "VG"; "50"];
2178 ["lvcreate"; "LV2"; "VG"; "50"];
2181 InitEmpty, Always, TestOutputList (
2182 [["part_disk"; "/dev/sda"; "mbr"];
2183 ["pvcreate"; "/dev/sda1"];
2184 ["vgcreate"; "VG"; "/dev/sda1"];
2185 ["lvcreate"; "LV1"; "VG"; "50"];
2186 ["lvcreate"; "LV2"; "VG"; "50"];
2189 "remove an LVM volume group",
2191 Remove an LVM volume group C<vgname>, (for example C<VG>).
2193 This also forcibly removes all logical volumes in the volume
2196 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2197 [InitEmpty, Always, TestOutputListOfDevices (
2198 [["part_disk"; "/dev/sda"; "mbr"];
2199 ["pvcreate"; "/dev/sda1"];
2200 ["vgcreate"; "VG"; "/dev/sda1"];
2201 ["lvcreate"; "LV1"; "VG"; "50"];
2202 ["lvcreate"; "LV2"; "VG"; "50"];
2204 ["pvremove"; "/dev/sda1"];
2206 InitEmpty, Always, TestOutputListOfDevices (
2207 [["part_disk"; "/dev/sda"; "mbr"];
2208 ["pvcreate"; "/dev/sda1"];
2209 ["vgcreate"; "VG"; "/dev/sda1"];
2210 ["lvcreate"; "LV1"; "VG"; "50"];
2211 ["lvcreate"; "LV2"; "VG"; "50"];
2213 ["pvremove"; "/dev/sda1"];
2215 InitEmpty, Always, TestOutputListOfDevices (
2216 [["part_disk"; "/dev/sda"; "mbr"];
2217 ["pvcreate"; "/dev/sda1"];
2218 ["vgcreate"; "VG"; "/dev/sda1"];
2219 ["lvcreate"; "LV1"; "VG"; "50"];
2220 ["lvcreate"; "LV2"; "VG"; "50"];
2222 ["pvremove"; "/dev/sda1"];
2224 "remove an LVM physical volume",
2226 This wipes a physical volume C<device> so that LVM will no longer
2229 The implementation uses the C<pvremove> command which refuses to
2230 wipe physical volumes that contain any volume groups, so you have
2231 to remove those first.");
2233 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2234 [InitBasicFS, Always, TestOutput (
2235 [["set_e2label"; "/dev/sda1"; "testlabel"];
2236 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2237 "set the ext2/3/4 filesystem label",
2239 This sets the ext2/3/4 filesystem label of the filesystem on
2240 C<device> to C<label>. Filesystem labels are limited to
2243 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2244 to return the existing label on a filesystem.");
2246 ("get_e2label", (RString "label", [Device "device"]), 81, [DeprecatedBy "vfs_label"],
2248 "get the ext2/3/4 filesystem label",
2250 This returns the ext2/3/4 filesystem label of the filesystem on
2253 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2254 (let uuid = uuidgen () in
2255 [InitBasicFS, Always, TestOutput (
2256 [["set_e2uuid"; "/dev/sda1"; uuid];
2257 ["get_e2uuid"; "/dev/sda1"]], uuid);
2258 InitBasicFS, Always, TestOutput (
2259 [["set_e2uuid"; "/dev/sda1"; "clear"];
2260 ["get_e2uuid"; "/dev/sda1"]], "");
2261 (* We can't predict what UUIDs will be, so just check the commands run. *)
2262 InitBasicFS, Always, TestRun (
2263 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2264 InitBasicFS, Always, TestRun (
2265 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2266 "set the ext2/3/4 filesystem UUID",
2268 This sets the ext2/3/4 filesystem UUID of the filesystem on
2269 C<device> to C<uuid>. The format of the UUID and alternatives
2270 such as C<clear>, C<random> and C<time> are described in the
2271 L<tune2fs(8)> manpage.
2273 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2274 to return the existing UUID of a filesystem.");
2276 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [DeprecatedBy "vfs_uuid"],
2277 (* Regression test for RHBZ#597112. *)
2278 (let uuid = uuidgen () in
2279 [InitBasicFS, Always, TestOutput (
2280 [["mke2journal"; "1024"; "/dev/sdb"];
2281 ["set_e2uuid"; "/dev/sdb"; uuid];
2282 ["get_e2uuid"; "/dev/sdb"]], uuid)]),
2283 "get the ext2/3/4 filesystem UUID",
2285 This returns the ext2/3/4 filesystem UUID of the filesystem on
2288 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2289 [InitBasicFS, Always, TestOutputInt (
2290 [["umount"; "/dev/sda1"];
2291 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2292 InitBasicFS, Always, TestOutputInt (
2293 [["umount"; "/dev/sda1"];
2294 ["zero"; "/dev/sda1"];
2295 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2296 "run the filesystem checker",
2298 This runs the filesystem checker (fsck) on C<device> which
2299 should have filesystem type C<fstype>.
2301 The returned integer is the status. See L<fsck(8)> for the
2302 list of status codes from C<fsck>.
2310 Multiple status codes can be summed together.
2314 A non-zero return code can mean \"success\", for example if
2315 errors have been corrected on the filesystem.
2319 Checking or repairing NTFS volumes is not supported
2324 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2326 ("zero", (RErr, [Device "device"]), 85, [],
2327 [InitBasicFS, Always, TestOutput (
2328 [["umount"; "/dev/sda1"];
2329 ["zero"; "/dev/sda1"];
2330 ["file"; "/dev/sda1"]], "data")],
2331 "write zeroes to the device",
2333 This command writes zeroes over the first few blocks of C<device>.
2335 How many blocks are zeroed isn't specified (but it's I<not> enough
2336 to securely wipe the device). It should be sufficient to remove
2337 any partition tables, filesystem superblocks and so on.
2339 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2341 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2343 * https://bugzilla.redhat.com/show_bug.cgi?id=484986
2344 * https://bugzilla.redhat.com/show_bug.cgi?id=479760
2346 [InitBasicFS, Always, TestOutputTrue (
2347 [["mkdir_p"; "/boot/grub"];
2348 ["write"; "/boot/grub/device.map"; "(hd0) /dev/vda"];
2349 ["grub_install"; "/"; "/dev/vda"];
2350 ["is_dir"; "/boot"]])],
2353 This command installs GRUB (the Grand Unified Bootloader) on
2354 C<device>, with the root directory being C<root>.
2356 Note: If grub-install reports the error
2357 \"No suitable drive was found in the generated device map.\"
2358 it may be that you need to create a C</boot/grub/device.map>
2359 file first that contains the mapping between grub device names
2360 and Linux device names. It is usually sufficient to create
2365 replacing C</dev/vda> with the name of the installation device.");
2367 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2368 [InitBasicFS, Always, TestOutput (
2369 [["write"; "/old"; "file content"];
2370 ["cp"; "/old"; "/new"];
2371 ["cat"; "/new"]], "file content");
2372 InitBasicFS, Always, TestOutputTrue (
2373 [["write"; "/old"; "file content"];
2374 ["cp"; "/old"; "/new"];
2375 ["is_file"; "/old"]]);
2376 InitBasicFS, Always, TestOutput (
2377 [["write"; "/old"; "file content"];
2379 ["cp"; "/old"; "/dir/new"];
2380 ["cat"; "/dir/new"]], "file content")],
2383 This copies a file from C<src> to C<dest> where C<dest> is
2384 either a destination filename or destination directory.");
2386 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2387 [InitBasicFS, Always, TestOutput (
2388 [["mkdir"; "/olddir"];
2389 ["mkdir"; "/newdir"];
2390 ["write"; "/olddir/file"; "file content"];
2391 ["cp_a"; "/olddir"; "/newdir"];
2392 ["cat"; "/newdir/olddir/file"]], "file content")],
2393 "copy a file or directory recursively",
2395 This copies a file or directory from C<src> to C<dest>
2396 recursively using the C<cp -a> command.");
2398 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2399 [InitBasicFS, Always, TestOutput (
2400 [["write"; "/old"; "file content"];
2401 ["mv"; "/old"; "/new"];
2402 ["cat"; "/new"]], "file content");
2403 InitBasicFS, Always, TestOutputFalse (
2404 [["write"; "/old"; "file content"];
2405 ["mv"; "/old"; "/new"];
2406 ["is_file"; "/old"]])],
2409 This moves a file from C<src> to C<dest> where C<dest> is
2410 either a destination filename or destination directory.");
2412 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2413 [InitEmpty, Always, TestRun (
2414 [["drop_caches"; "3"]])],
2415 "drop kernel page cache, dentries and inodes",
2417 This instructs the guest kernel to drop its page cache,
2418 and/or dentries and inode caches. The parameter C<whattodrop>
2419 tells the kernel what precisely to drop, see
2420 L<http://linux-mm.org/Drop_Caches>
2422 Setting C<whattodrop> to 3 should drop everything.
2424 This automatically calls L<sync(2)> before the operation,
2425 so that the maximum guest memory is freed.");
2427 ("dmesg", (RString "kmsgs", []), 91, [],
2428 [InitEmpty, Always, TestRun (
2430 "return kernel messages",
2432 This returns the kernel messages (C<dmesg> output) from
2433 the guest kernel. This is sometimes useful for extended
2434 debugging of problems.
2436 Another way to get the same information is to enable
2437 verbose messages with C<guestfs_set_verbose> or by setting
2438 the environment variable C<LIBGUESTFS_DEBUG=1> before
2439 running the program.");
2441 ("ping_daemon", (RErr, []), 92, [],
2442 [InitEmpty, Always, TestRun (
2443 [["ping_daemon"]])],
2444 "ping the guest daemon",
2446 This is a test probe into the guestfs daemon running inside
2447 the qemu subprocess. Calling this function checks that the
2448 daemon responds to the ping message, without affecting the daemon
2449 or attached block device(s) in any other way.");
2451 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2452 [InitBasicFS, Always, TestOutputTrue (
2453 [["write"; "/file1"; "contents of a file"];
2454 ["cp"; "/file1"; "/file2"];
2455 ["equal"; "/file1"; "/file2"]]);
2456 InitBasicFS, Always, TestOutputFalse (
2457 [["write"; "/file1"; "contents of a file"];
2458 ["write"; "/file2"; "contents of another file"];
2459 ["equal"; "/file1"; "/file2"]]);
2460 InitBasicFS, Always, TestLastFail (
2461 [["equal"; "/file1"; "/file2"]])],
2462 "test if two files have equal contents",
2464 This compares the two files C<file1> and C<file2> and returns
2465 true if their content is exactly equal, or false otherwise.
2467 The external L<cmp(1)> program is used for the comparison.");
2469 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2470 [InitISOFS, Always, TestOutputList (
2471 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2472 InitISOFS, Always, TestOutputList (
2473 [["strings"; "/empty"]], []);
2474 (* Test for RHBZ#579608, absolute symbolic links. *)
2475 InitISOFS, Always, TestRun (
2476 [["strings"; "/abssymlink"]])],
2477 "print the printable strings in a file",
2479 This runs the L<strings(1)> command on a file and returns
2480 the list of printable strings found.");
2482 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2483 [InitISOFS, Always, TestOutputList (
2484 [["strings_e"; "b"; "/known-5"]], []);
2485 InitBasicFS, Always, TestOutputList (
2486 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2487 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2488 "print the printable strings in a file",
2490 This is like the C<guestfs_strings> command, but allows you to
2491 specify the encoding of strings that are looked for in
2492 the source file C<path>.
2494 Allowed encodings are:
2500 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2501 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2505 Single 8-bit-byte characters.
2509 16-bit big endian strings such as those encoded in
2510 UTF-16BE or UCS-2BE.
2512 =item l (lower case letter L)
2514 16-bit little endian such as UTF-16LE and UCS-2LE.
2515 This is useful for examining binaries in Windows guests.
2519 32-bit big endian such as UCS-4BE.
2523 32-bit little endian such as UCS-4LE.
2527 The returned strings are transcoded to UTF-8.");
2529 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2530 [InitISOFS, Always, TestOutput (
2531 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2532 (* Test for RHBZ#501888c2 regression which caused large hexdump
2533 * commands to segfault.
2535 InitISOFS, Always, TestRun (
2536 [["hexdump"; "/100krandom"]]);
2537 (* Test for RHBZ#579608, absolute symbolic links. *)
2538 InitISOFS, Always, TestRun (
2539 [["hexdump"; "/abssymlink"]])],
2540 "dump a file in hexadecimal",
2542 This runs C<hexdump -C> on the given C<path>. The result is
2543 the human-readable, canonical hex dump of the file.");
2545 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2546 [InitNone, Always, TestOutput (
2547 [["part_disk"; "/dev/sda"; "mbr"];
2548 ["mkfs"; "ext3"; "/dev/sda1"];
2549 ["mount_options"; ""; "/dev/sda1"; "/"];
2550 ["write"; "/new"; "test file"];
2551 ["umount"; "/dev/sda1"];
2552 ["zerofree"; "/dev/sda1"];
2553 ["mount_options"; ""; "/dev/sda1"; "/"];
2554 ["cat"; "/new"]], "test file")],
2555 "zero unused inodes and disk blocks on ext2/3 filesystem",
2557 This runs the I<zerofree> program on C<device>. This program
2558 claims to zero unused inodes and disk blocks on an ext2/3
2559 filesystem, thus making it possible to compress the filesystem
2562 You should B<not> run this program if the filesystem is
2565 It is possible that using this program can damage the filesystem
2566 or data on the filesystem.");
2568 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2570 "resize an LVM physical volume",
2572 This resizes (expands or shrinks) an existing LVM physical
2573 volume to match the new size of the underlying device.");
2575 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2576 Int "cyls"; Int "heads"; Int "sectors";
2577 String "line"]), 99, [DangerWillRobinson],
2579 "modify a single partition on a block device",
2581 This runs L<sfdisk(8)> option to modify just the single
2582 partition C<n> (note: C<n> counts from 1).
2584 For other parameters, see C<guestfs_sfdisk>. You should usually
2585 pass C<0> for the cyls/heads/sectors parameters.
2587 See also: C<guestfs_part_add>");
2589 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2591 "display the partition table",
2593 This displays the partition table on C<device>, in the
2594 human-readable output of the L<sfdisk(8)> command. It is
2595 not intended to be parsed.
2597 See also: C<guestfs_part_list>");
2599 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2601 "display the kernel geometry",
2603 This displays the kernel's idea of the geometry of C<device>.
2605 The result is in human-readable format, and not designed to
2608 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2610 "display the disk geometry from the partition table",
2612 This displays the disk geometry of C<device> read from the
2613 partition table. Especially in the case where the underlying
2614 block device has been resized, this can be different from the
2615 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2617 The result is in human-readable format, and not designed to
2620 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2622 "activate or deactivate all volume groups",
2624 This command activates or (if C<activate> is false) deactivates
2625 all logical volumes in all volume groups.
2626 If activated, then they are made known to the
2627 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2628 then those devices disappear.
2630 This command is the same as running C<vgchange -a y|n>");
2632 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2634 "activate or deactivate some volume groups",
2636 This command activates or (if C<activate> is false) deactivates
2637 all logical volumes in the listed volume groups C<volgroups>.
2638 If activated, then they are made known to the
2639 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2640 then those devices disappear.
2642 This command is the same as running C<vgchange -a y|n volgroups...>
2644 Note that if C<volgroups> is an empty list then B<all> volume groups
2645 are activated or deactivated.");
2647 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2648 [InitNone, Always, TestOutput (
2649 [["part_disk"; "/dev/sda"; "mbr"];
2650 ["pvcreate"; "/dev/sda1"];
2651 ["vgcreate"; "VG"; "/dev/sda1"];
2652 ["lvcreate"; "LV"; "VG"; "10"];
2653 ["mkfs"; "ext2"; "/dev/VG/LV"];
2654 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2655 ["write"; "/new"; "test content"];
2657 ["lvresize"; "/dev/VG/LV"; "20"];
2658 ["e2fsck_f"; "/dev/VG/LV"];
2659 ["resize2fs"; "/dev/VG/LV"];
2660 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2661 ["cat"; "/new"]], "test content");
2662 InitNone, Always, TestRun (
2663 (* Make an LV smaller to test RHBZ#587484. *)
2664 [["part_disk"; "/dev/sda"; "mbr"];
2665 ["pvcreate"; "/dev/sda1"];
2666 ["vgcreate"; "VG"; "/dev/sda1"];
2667 ["lvcreate"; "LV"; "VG"; "20"];
2668 ["lvresize"; "/dev/VG/LV"; "10"]])],
2669 "resize an LVM logical volume",
2671 This resizes (expands or shrinks) an existing LVM logical
2672 volume to C<mbytes>. When reducing, data in the reduced part
2675 ("resize2fs", (RErr, [Device "device"]), 106, [],
2676 [], (* lvresize tests this *)
2677 "resize an ext2, ext3 or ext4 filesystem",
2679 This resizes an ext2, ext3 or ext4 filesystem to match the size of
2680 the underlying device.
2682 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2683 on the C<device> before calling this command. For unknown reasons
2684 C<resize2fs> sometimes gives an error about this and sometimes not.
2685 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2686 calling this function.");
2688 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2689 [InitBasicFS, Always, TestOutputList (
2690 [["find"; "/"]], ["lost+found"]);
2691 InitBasicFS, Always, TestOutputList (
2695 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2696 InitBasicFS, Always, TestOutputList (
2697 [["mkdir_p"; "/a/b/c"];
2698 ["touch"; "/a/b/c/d"];
2699 ["find"; "/a/b/"]], ["c"; "c/d"])],
2700 "find all files and directories",
2702 This command lists out all files and directories, recursively,
2703 starting at C<directory>. It is essentially equivalent to
2704 running the shell command C<find directory -print> but some
2705 post-processing happens on the output, described below.
2707 This returns a list of strings I<without any prefix>. Thus
2708 if the directory structure was:
2714 then the returned list from C<guestfs_find> C</tmp> would be
2722 If C<directory> is not a directory, then this command returns
2725 The returned list is sorted.
2727 See also C<guestfs_find0>.");
2729 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2730 [], (* lvresize tests this *)
2731 "check an ext2/ext3 filesystem",
2733 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2734 filesystem checker on C<device>, noninteractively (C<-p>),
2735 even if the filesystem appears to be clean (C<-f>).
2737 This command is only needed because of C<guestfs_resize2fs>
2738 (q.v.). Normally you should use C<guestfs_fsck>.");
2740 ("sleep", (RErr, [Int "secs"]), 109, [],
2741 [InitNone, Always, TestRun (
2743 "sleep for some seconds",
2745 Sleep for C<secs> seconds.");
2747 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2748 [InitNone, Always, TestOutputInt (
2749 [["part_disk"; "/dev/sda"; "mbr"];
2750 ["mkfs"; "ntfs"; "/dev/sda1"];
2751 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2752 InitNone, Always, TestOutputInt (
2753 [["part_disk"; "/dev/sda"; "mbr"];
2754 ["mkfs"; "ext2"; "/dev/sda1"];
2755 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2756 "probe NTFS volume",
2758 This command runs the L<ntfs-3g.probe(8)> command which probes
2759 an NTFS C<device> for mountability. (Not all NTFS volumes can
2760 be mounted read-write, and some cannot be mounted at all).
2762 C<rw> is a boolean flag. Set it to true if you want to test
2763 if the volume can be mounted read-write. Set it to false if
2764 you want to test if the volume can be mounted read-only.
2766 The return value is an integer which C<0> if the operation
2767 would succeed, or some non-zero value documented in the
2768 L<ntfs-3g.probe(8)> manual page.");
2770 ("sh", (RString "output", [String "command"]), 111, [],
2771 [], (* XXX needs tests *)
2772 "run a command via the shell",
2774 This call runs a command from the guest filesystem via the
2777 This is like C<guestfs_command>, but passes the command to:
2779 /bin/sh -c \"command\"
2781 Depending on the guest's shell, this usually results in
2782 wildcards being expanded, shell expressions being interpolated
2785 All the provisos about C<guestfs_command> apply to this call.");
2787 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2788 [], (* XXX needs tests *)
2789 "run a command via the shell returning lines",
2791 This is the same as C<guestfs_sh>, but splits the result
2792 into a list of lines.
2794 See also: C<guestfs_command_lines>");
2796 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2797 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2798 * code in stubs.c, since all valid glob patterns must start with "/".
2799 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2801 [InitBasicFS, Always, TestOutputList (
2802 [["mkdir_p"; "/a/b/c"];
2803 ["touch"; "/a/b/c/d"];
2804 ["touch"; "/a/b/c/e"];
2805 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2806 InitBasicFS, Always, TestOutputList (
2807 [["mkdir_p"; "/a/b/c"];
2808 ["touch"; "/a/b/c/d"];
2809 ["touch"; "/a/b/c/e"];
2810 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2811 InitBasicFS, Always, TestOutputList (
2812 [["mkdir_p"; "/a/b/c"];
2813 ["touch"; "/a/b/c/d"];
2814 ["touch"; "/a/b/c/e"];
2815 ["glob_expand"; "/a/*/x/*"]], [])],
2816 "expand a wildcard path",
2818 This command searches for all the pathnames matching
2819 C<pattern> according to the wildcard expansion rules
2822 If no paths match, then this returns an empty list
2823 (note: not an error).
2825 It is just a wrapper around the C L<glob(3)> function
2826 with flags C<GLOB_MARK|GLOB_BRACE>.
2827 See that manual page for more details.");
2829 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2830 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2831 [["scrub_device"; "/dev/sdc"]])],
2832 "scrub (securely wipe) a device",
2834 This command writes patterns over C<device> to make data retrieval
2837 It is an interface to the L<scrub(1)> program. See that
2838 manual page for more details.");
2840 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2841 [InitBasicFS, Always, TestRun (
2842 [["write"; "/file"; "content"];
2843 ["scrub_file"; "/file"]])],
2844 "scrub (securely wipe) a file",
2846 This command writes patterns over a file to make data retrieval
2849 The file is I<removed> after scrubbing.
2851 It is an interface to the L<scrub(1)> program. See that
2852 manual page for more details.");
2854 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2855 [], (* XXX needs testing *)
2856 "scrub (securely wipe) free space",
2858 This command creates the directory C<dir> and then fills it
2859 with files until the filesystem is full, and scrubs the files
2860 as for C<guestfs_scrub_file>, and deletes them.
2861 The intention is to scrub any free space on the partition
2864 It is an interface to the L<scrub(1)> program. See that
2865 manual page for more details.");
2867 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2868 [InitBasicFS, Always, TestRun (
2870 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2871 "create a temporary directory",
2873 This command creates a temporary directory. The
2874 C<template> parameter should be a full pathname for the
2875 temporary directory name with the final six characters being
2878 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2879 the second one being suitable for Windows filesystems.
2881 The name of the temporary directory that was created
2884 The temporary directory is created with mode 0700
2885 and is owned by root.
2887 The caller is responsible for deleting the temporary
2888 directory and its contents after use.
2890 See also: L<mkdtemp(3)>");
2892 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2893 [InitISOFS, Always, TestOutputInt (
2894 [["wc_l"; "/10klines"]], 10000);
2895 (* Test for RHBZ#579608, absolute symbolic links. *)
2896 InitISOFS, Always, TestOutputInt (
2897 [["wc_l"; "/abssymlink"]], 10000)],
2898 "count lines in a file",
2900 This command counts the lines in a file, using the
2901 C<wc -l> external command.");
2903 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2904 [InitISOFS, Always, TestOutputInt (
2905 [["wc_w"; "/10klines"]], 10000)],
2906 "count words in a file",
2908 This command counts the words in a file, using the
2909 C<wc -w> external command.");
2911 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2912 [InitISOFS, Always, TestOutputInt (
2913 [["wc_c"; "/100kallspaces"]], 102400)],
2914 "count characters in a file",
2916 This command counts the characters in a file, using the
2917 C<wc -c> external command.");
2919 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2920 [InitISOFS, Always, TestOutputList (
2921 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2922 (* Test for RHBZ#579608, absolute symbolic links. *)
2923 InitISOFS, Always, TestOutputList (
2924 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2925 "return first 10 lines of a file",
2927 This command returns up to the first 10 lines of a file as
2928 a list of strings.");
2930 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2931 [InitISOFS, Always, TestOutputList (
2932 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2933 InitISOFS, Always, TestOutputList (
2934 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2935 InitISOFS, Always, TestOutputList (
2936 [["head_n"; "0"; "/10klines"]], [])],
2937 "return first N lines of a file",
2939 If the parameter C<nrlines> is a positive number, this returns the first
2940 C<nrlines> lines of the file C<path>.
2942 If the parameter C<nrlines> is a negative number, this returns lines
2943 from the file C<path>, excluding the last C<nrlines> lines.
2945 If the parameter C<nrlines> is zero, this returns an empty list.");
2947 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2948 [InitISOFS, Always, TestOutputList (
2949 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2950 "return last 10 lines of a file",
2952 This command returns up to the last 10 lines of a file as
2953 a list of strings.");
2955 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2956 [InitISOFS, Always, TestOutputList (
2957 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2958 InitISOFS, Always, TestOutputList (
2959 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2960 InitISOFS, Always, TestOutputList (
2961 [["tail_n"; "0"; "/10klines"]], [])],
2962 "return last N lines of a file",
2964 If the parameter C<nrlines> is a positive number, this returns the last
2965 C<nrlines> lines of the file C<path>.
2967 If the parameter C<nrlines> is a negative number, this returns lines
2968 from the file C<path>, starting with the C<-nrlines>th line.
2970 If the parameter C<nrlines> is zero, this returns an empty list.");
2972 ("df", (RString "output", []), 125, [],
2973 [], (* XXX Tricky to test because it depends on the exact format
2974 * of the 'df' command and other imponderables.
2976 "report file system disk space usage",
2978 This command runs the C<df> command to report disk space used.
2980 This command is mostly useful for interactive sessions. It
2981 is I<not> intended that you try to parse the output string.
2982 Use C<statvfs> from programs.");
2984 ("df_h", (RString "output", []), 126, [],
2985 [], (* XXX Tricky to test because it depends on the exact format
2986 * of the 'df' command and other imponderables.
2988 "report file system disk space usage (human readable)",
2990 This command runs the C<df -h> command to report disk space used
2991 in human-readable format.
2993 This command is mostly useful for interactive sessions. It
2994 is I<not> intended that you try to parse the output string.
2995 Use C<statvfs> from programs.");
2997 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2998 [InitISOFS, Always, TestOutputInt (
2999 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
3000 "estimate file space usage",
3002 This command runs the C<du -s> command to estimate file space
3005 C<path> can be a file or a directory. If C<path> is a directory
3006 then the estimate includes the contents of the directory and all
3007 subdirectories (recursively).
3009 The result is the estimated size in I<kilobytes>
3010 (ie. units of 1024 bytes).");
3012 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
3013 [InitISOFS, Always, TestOutputList (
3014 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
3015 "list files in an initrd",
3017 This command lists out files contained in an initrd.
3019 The files are listed without any initial C</> character. The
3020 files are listed in the order they appear (not necessarily
3021 alphabetical). Directory names are listed as separate items.
3023 Old Linux kernels (2.4 and earlier) used a compressed ext2
3024 filesystem as initrd. We I<only> support the newer initramfs
3025 format (compressed cpio files).");
3027 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
3029 "mount a file using the loop device",
3031 This command lets you mount C<file> (a filesystem image
3032 in a file) on a mount point. It is entirely equivalent to
3033 the command C<mount -o loop file mountpoint>.");
3035 ("mkswap", (RErr, [Device "device"]), 130, [],
3036 [InitEmpty, Always, TestRun (
3037 [["part_disk"; "/dev/sda"; "mbr"];
3038 ["mkswap"; "/dev/sda1"]])],
3039 "create a swap partition",
3041 Create a swap partition on C<device>.");
3043 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
3044 [InitEmpty, Always, TestRun (
3045 [["part_disk"; "/dev/sda"; "mbr"];
3046 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3047 "create a swap partition with a label",
3049 Create a swap partition on C<device> with label C<label>.
3051 Note that you cannot attach a swap label to a block device
3052 (eg. C</dev/sda>), just to a partition. This appears to be
3053 a limitation of the kernel or swap tools.");
3055 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3056 (let uuid = uuidgen () in
3057 [InitEmpty, Always, TestRun (
3058 [["part_disk"; "/dev/sda"; "mbr"];
3059 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3060 "create a swap partition with an explicit UUID",
3062 Create a swap partition on C<device> with UUID C<uuid>.");
3064 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3065 [InitBasicFS, Always, TestOutputStruct (
3066 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3067 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3068 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3069 InitBasicFS, Always, TestOutputStruct (
3070 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3071 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3072 "make block, character or FIFO devices",
3074 This call creates block or character special devices, or
3075 named pipes (FIFOs).
3077 The C<mode> parameter should be the mode, using the standard
3078 constants. C<devmajor> and C<devminor> are the
3079 device major and minor numbers, only used when creating block
3080 and character special devices.
3082 Note that, just like L<mknod(2)>, the mode must be bitwise
3083 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3084 just creates a regular file). These constants are
3085 available in the standard Linux header files, or you can use
3086 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3087 which are wrappers around this command which bitwise OR
3088 in the appropriate constant for you.
3090 The mode actually set is affected by the umask.");
3092 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3093 [InitBasicFS, Always, TestOutputStruct (
3094 [["mkfifo"; "0o777"; "/node"];
3095 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3096 "make FIFO (named pipe)",
3098 This call creates a FIFO (named pipe) called C<path> with
3099 mode C<mode>. It is just a convenient wrapper around
3102 The mode actually set is affected by the umask.");
3104 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3105 [InitBasicFS, Always, TestOutputStruct (
3106 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3107 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3108 "make block device node",
3110 This call creates a block device node called C<path> with
3111 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3112 It is just a convenient wrapper around C<guestfs_mknod>.
3114 The mode actually set is affected by the umask.");
3116 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3117 [InitBasicFS, Always, TestOutputStruct (
3118 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3119 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3120 "make char device node",
3122 This call creates a char device node called C<path> with
3123 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3124 It is just a convenient wrapper around C<guestfs_mknod>.
3126 The mode actually set is affected by the umask.");
3128 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3129 [InitEmpty, Always, TestOutputInt (
3130 [["umask"; "0o22"]], 0o22)],
3131 "set file mode creation mask (umask)",
3133 This function sets the mask used for creating new files and
3134 device nodes to C<mask & 0777>.
3136 Typical umask values would be C<022> which creates new files
3137 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3138 C<002> which creates new files with permissions like
3139 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3141 The default umask is C<022>. This is important because it
3142 means that directories and device nodes will be created with
3143 C<0644> or C<0755> mode even if you specify C<0777>.
3145 See also C<guestfs_get_umask>,
3146 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3148 This call returns the previous umask.");
3150 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3152 "read directories entries",
3154 This returns the list of directory entries in directory C<dir>.
3156 All entries in the directory are returned, including C<.> and
3157 C<..>. The entries are I<not> sorted, but returned in the same
3158 order as the underlying filesystem.
3160 Also this call returns basic file type information about each
3161 file. The C<ftyp> field will contain one of the following characters:
3199 The L<readdir(3)> call returned a C<d_type> field with an
3204 This function is primarily intended for use by programs. To
3205 get a simple list of names, use C<guestfs_ls>. To get a printable
3206 directory for human consumption, use C<guestfs_ll>.");
3208 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3210 "create partitions on a block device",
3212 This is a simplified interface to the C<guestfs_sfdisk>
3213 command, where partition sizes are specified in megabytes
3214 only (rounded to the nearest cylinder) and you don't need
3215 to specify the cyls, heads and sectors parameters which
3216 were rarely if ever used anyway.
3218 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3219 and C<guestfs_part_disk>");
3221 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3223 "determine file type inside a compressed file",
3225 This command runs C<file> after first decompressing C<path>
3228 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3230 Since 1.0.63, use C<guestfs_file> instead which can now
3231 process compressed files.");
3233 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3235 "list extended attributes of a file or directory",
3237 This call lists the extended attributes of the file or directory
3240 At the system call level, this is a combination of the
3241 L<listxattr(2)> and L<getxattr(2)> calls.
3243 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3245 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3247 "list extended attributes of a file or directory",
3249 This is the same as C<guestfs_getxattrs>, but if C<path>
3250 is a symbolic link, then it returns the extended attributes
3251 of the link itself.");
3253 ("setxattr", (RErr, [String "xattr";
3254 String "val"; Int "vallen"; (* will be BufferIn *)
3255 Pathname "path"]), 143, [Optional "linuxxattrs"],
3257 "set extended attribute of a file or directory",
3259 This call sets the extended attribute named C<xattr>
3260 of the file C<path> to the value C<val> (of length C<vallen>).
3261 The value is arbitrary 8 bit data.
3263 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3265 ("lsetxattr", (RErr, [String "xattr";
3266 String "val"; Int "vallen"; (* will be BufferIn *)
3267 Pathname "path"]), 144, [Optional "linuxxattrs"],
3269 "set extended attribute of a file or directory",
3271 This is the same as C<guestfs_setxattr>, but if C<path>
3272 is a symbolic link, then it sets an extended attribute
3273 of the link itself.");
3275 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3277 "remove extended attribute of a file or directory",
3279 This call removes the extended attribute named C<xattr>
3280 of the file C<path>.
3282 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3284 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3286 "remove extended attribute of a file or directory",
3288 This is the same as C<guestfs_removexattr>, but if C<path>
3289 is a symbolic link, then it removes an extended attribute
3290 of the link itself.");
3292 ("mountpoints", (RHashtable "mps", []), 147, [],
3296 This call is similar to C<guestfs_mounts>. That call returns
3297 a list of devices. This one returns a hash table (map) of
3298 device name to directory where the device is mounted.");
3300 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3301 (* This is a special case: while you would expect a parameter
3302 * of type "Pathname", that doesn't work, because it implies
3303 * NEED_ROOT in the generated calling code in stubs.c, and
3304 * this function cannot use NEED_ROOT.
3307 "create a mountpoint",
3309 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3310 specialized calls that can be used to create extra mountpoints
3311 before mounting the first filesystem.
3313 These calls are I<only> necessary in some very limited circumstances,
3314 mainly the case where you want to mount a mix of unrelated and/or
3315 read-only filesystems together.
3317 For example, live CDs often contain a \"Russian doll\" nest of
3318 filesystems, an ISO outer layer, with a squashfs image inside, with
3319 an ext2/3 image inside that. You can unpack this as follows
3322 add-ro Fedora-11-i686-Live.iso
3325 mkmountpoint /squash
3328 mount-loop /cd/LiveOS/squashfs.img /squash
3329 mount-loop /squash/LiveOS/ext3fs.img /ext3
3331 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3333 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3335 "remove a mountpoint",
3337 This calls removes a mountpoint that was previously created
3338 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3339 for full details.");
3341 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3342 [InitISOFS, Always, TestOutputBuffer (
3343 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3344 (* Test various near large, large and too large files (RHBZ#589039). *)
3345 InitBasicFS, Always, TestLastFail (
3347 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3348 ["read_file"; "/a"]]);
3349 InitBasicFS, Always, TestLastFail (
3351 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3352 ["read_file"; "/a"]]);
3353 InitBasicFS, Always, TestLastFail (
3355 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3356 ["read_file"; "/a"]])],
3359 This calls returns the contents of the file C<path> as a
3362 Unlike C<guestfs_cat>, this function can correctly
3363 handle files that contain embedded ASCII NUL characters.
3364 However unlike C<guestfs_download>, this function is limited
3365 in the total size of file that can be handled.");
3367 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3368 [InitISOFS, Always, TestOutputList (
3369 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3370 InitISOFS, Always, TestOutputList (
3371 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3372 (* Test for RHBZ#579608, absolute symbolic links. *)
3373 InitISOFS, Always, TestOutputList (
3374 [["grep"; "nomatch"; "/abssymlink"]], [])],
3375 "return lines matching a pattern",
3377 This calls the external C<grep> program and returns the
3380 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3381 [InitISOFS, Always, TestOutputList (
3382 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3383 "return lines matching a pattern",
3385 This calls the external C<egrep> program and returns the
3388 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3389 [InitISOFS, Always, TestOutputList (
3390 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3391 "return lines matching a pattern",
3393 This calls the external C<fgrep> program and returns the
3396 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3397 [InitISOFS, Always, TestOutputList (
3398 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3399 "return lines matching a pattern",
3401 This calls the external C<grep -i> program and returns the
3404 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3405 [InitISOFS, Always, TestOutputList (
3406 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3407 "return lines matching a pattern",
3409 This calls the external C<egrep -i> program and returns the
3412 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3413 [InitISOFS, Always, TestOutputList (
3414 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3415 "return lines matching a pattern",
3417 This calls the external C<fgrep -i> program and returns the
3420 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3421 [InitISOFS, Always, TestOutputList (
3422 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3423 "return lines matching a pattern",
3425 This calls the external C<zgrep> program and returns the
3428 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3429 [InitISOFS, Always, TestOutputList (
3430 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3431 "return lines matching a pattern",
3433 This calls the external C<zegrep> program and returns the
3436 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3437 [InitISOFS, Always, TestOutputList (
3438 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3439 "return lines matching a pattern",
3441 This calls the external C<zfgrep> program and returns the
3444 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3445 [InitISOFS, Always, TestOutputList (
3446 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3447 "return lines matching a pattern",
3449 This calls the external C<zgrep -i> program and returns the
3452 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3453 [InitISOFS, Always, TestOutputList (
3454 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3455 "return lines matching a pattern",
3457 This calls the external C<zegrep -i> program and returns the
3460 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3461 [InitISOFS, Always, TestOutputList (
3462 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3463 "return lines matching a pattern",
3465 This calls the external C<zfgrep -i> program and returns the
3468 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3469 [InitISOFS, Always, TestOutput (
3470 [["realpath"; "/../directory"]], "/directory")],
3471 "canonicalized absolute pathname",
3473 Return the canonicalized absolute pathname of C<path>. The
3474 returned path has no C<.>, C<..> or symbolic link path elements.");
3476 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3477 [InitBasicFS, Always, TestOutputStruct (
3480 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3481 "create a hard link",
3483 This command creates a hard link using the C<ln> command.");
3485 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3486 [InitBasicFS, Always, TestOutputStruct (
3489 ["ln_f"; "/a"; "/b"];
3490 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3491 "create a hard link",
3493 This command creates a hard link using the C<ln -f> command.
3494 The C<-f> option removes the link (C<linkname>) if it exists already.");
3496 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3497 [InitBasicFS, Always, TestOutputStruct (
3499 ["ln_s"; "a"; "/b"];
3500 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3501 "create a symbolic link",
3503 This command creates a symbolic link using the C<ln -s> command.");
3505 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3506 [InitBasicFS, Always, TestOutput (
3507 [["mkdir_p"; "/a/b"];
3508 ["touch"; "/a/b/c"];
3509 ["ln_sf"; "../d"; "/a/b/c"];
3510 ["readlink"; "/a/b/c"]], "../d")],
3511 "create a symbolic link",
3513 This command creates a symbolic link using the C<ln -sf> command,
3514 The C<-f> option removes the link (C<linkname>) if it exists already.");
3516 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3517 [] (* XXX tested above *),
3518 "read the target of a symbolic link",
3520 This command reads the target of a symbolic link.");
3522 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [DeprecatedBy "fallocate64"],
3523 [InitBasicFS, Always, TestOutputStruct (
3524 [["fallocate"; "/a"; "1000000"];
3525 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3526 "preallocate a file in the guest filesystem",
3528 This command preallocates a file (containing zero bytes) named
3529 C<path> of size C<len> bytes. If the file exists already, it
3532 Do not confuse this with the guestfish-specific
3533 C<alloc> command which allocates a file in the host and
3534 attaches it as a device.");
3536 ("swapon_device", (RErr, [Device "device"]), 170, [],
3537 [InitPartition, Always, TestRun (
3538 [["mkswap"; "/dev/sda1"];
3539 ["swapon_device"; "/dev/sda1"];
3540 ["swapoff_device"; "/dev/sda1"]])],
3541 "enable swap on device",
3543 This command enables the libguestfs appliance to use the
3544 swap device or partition named C<device>. The increased
3545 memory is made available for all commands, for example
3546 those run using C<guestfs_command> or C<guestfs_sh>.
3548 Note that you should not swap to existing guest swap
3549 partitions unless you know what you are doing. They may
3550 contain hibernation information, or other information that
3551 the guest doesn't want you to trash. You also risk leaking
3552 information about the host to the guest this way. Instead,
3553 attach a new host device to the guest and swap on that.");
3555 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3556 [], (* XXX tested by swapon_device *)
3557 "disable swap on device",
3559 This command disables the libguestfs appliance swap
3560 device or partition named C<device>.
3561 See C<guestfs_swapon_device>.");
3563 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3564 [InitBasicFS, Always, TestRun (
3565 [["fallocate"; "/swap"; "8388608"];
3566 ["mkswap_file"; "/swap"];
3567 ["swapon_file"; "/swap"];
3568 ["swapoff_file"; "/swap"]])],
3569 "enable swap on file",
3571 This command enables swap to a file.
3572 See C<guestfs_swapon_device> for other notes.");
3574 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3575 [], (* XXX tested by swapon_file *)
3576 "disable swap on file",
3578 This command disables the libguestfs appliance swap on file.");
3580 ("swapon_label", (RErr, [String "label"]), 174, [],
3581 [InitEmpty, Always, TestRun (
3582 [["part_disk"; "/dev/sdb"; "mbr"];
3583 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3584 ["swapon_label"; "swapit"];
3585 ["swapoff_label"; "swapit"];
3586 ["zero"; "/dev/sdb"];
3587 ["blockdev_rereadpt"; "/dev/sdb"]])],
3588 "enable swap on labeled swap partition",
3590 This command enables swap to a labeled swap partition.
3591 See C<guestfs_swapon_device> for other notes.");
3593 ("swapoff_label", (RErr, [String "label"]), 175, [],
3594 [], (* XXX tested by swapon_label *)
3595 "disable swap on labeled swap partition",
3597 This command disables the libguestfs appliance swap on
3598 labeled swap partition.");
3600 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3601 (let uuid = uuidgen () in
3602 [InitEmpty, Always, TestRun (
3603 [["mkswap_U"; uuid; "/dev/sdb"];
3604 ["swapon_uuid"; uuid];
3605 ["swapoff_uuid"; uuid]])]),
3606 "enable swap on swap partition by UUID",
3608 This command enables swap to a swap partition with the given UUID.
3609 See C<guestfs_swapon_device> for other notes.");
3611 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3612 [], (* XXX tested by swapon_uuid *)
3613 "disable swap on swap partition by UUID",
3615 This command disables the libguestfs appliance swap partition
3616 with the given UUID.");
3618 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3619 [InitBasicFS, Always, TestRun (
3620 [["fallocate"; "/swap"; "8388608"];
3621 ["mkswap_file"; "/swap"]])],
3622 "create a swap file",
3626 This command just writes a swap file signature to an existing
3627 file. To create the file itself, use something like C<guestfs_fallocate>.");
3629 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3630 [InitISOFS, Always, TestRun (
3631 [["inotify_init"; "0"]])],
3632 "create an inotify handle",
3634 This command creates a new inotify handle.
3635 The inotify subsystem can be used to notify events which happen to
3636 objects in the guest filesystem.
3638 C<maxevents> is the maximum number of events which will be
3639 queued up between calls to C<guestfs_inotify_read> or
3640 C<guestfs_inotify_files>.
3641 If this is passed as C<0>, then the kernel (or previously set)
3642 default is used. For Linux 2.6.29 the default was 16384 events.
3643 Beyond this limit, the kernel throws away events, but records
3644 the fact that it threw them away by setting a flag
3645 C<IN_Q_OVERFLOW> in the returned structure list (see
3646 C<guestfs_inotify_read>).
3648 Before any events are generated, you have to add some
3649 watches to the internal watch list. See:
3650 C<guestfs_inotify_add_watch>,
3651 C<guestfs_inotify_rm_watch> and
3652 C<guestfs_inotify_watch_all>.
3654 Queued up events should be read periodically by calling
3655 C<guestfs_inotify_read>
3656 (or C<guestfs_inotify_files> which is just a helpful
3657 wrapper around C<guestfs_inotify_read>). If you don't
3658 read the events out often enough then you risk the internal
3661 The handle should be closed after use by calling
3662 C<guestfs_inotify_close>. This also removes any
3663 watches automatically.
3665 See also L<inotify(7)> for an overview of the inotify interface
3666 as exposed by the Linux kernel, which is roughly what we expose
3667 via libguestfs. Note that there is one global inotify handle
3668 per libguestfs instance.");
3670 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3671 [InitBasicFS, Always, TestOutputList (
3672 [["inotify_init"; "0"];
3673 ["inotify_add_watch"; "/"; "1073741823"];
3676 ["inotify_files"]], ["a"; "b"])],
3677 "add an inotify watch",
3679 Watch C<path> for the events listed in C<mask>.
3681 Note that if C<path> is a directory then events within that
3682 directory are watched, but this does I<not> happen recursively
3683 (in subdirectories).
3685 Note for non-C or non-Linux callers: the inotify events are
3686 defined by the Linux kernel ABI and are listed in
3687 C</usr/include/sys/inotify.h>.");
3689 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3691 "remove an inotify watch",
3693 Remove a previously defined inotify watch.
3694 See C<guestfs_inotify_add_watch>.");
3696 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3698 "return list of inotify events",
3700 Return the complete queue of events that have happened
3701 since the previous read call.
3703 If no events have happened, this returns an empty list.
3705 I<Note>: In order to make sure that all events have been
3706 read, you must call this function repeatedly until it
3707 returns an empty list. The reason is that the call will
3708 read events up to the maximum appliance-to-host message
3709 size and leave remaining events in the queue.");
3711 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3713 "return list of watched files that had events",
3715 This function is a helpful wrapper around C<guestfs_inotify_read>
3716 which just returns a list of pathnames of objects that were
3717 touched. The returned pathnames are sorted and deduplicated.");
3719 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3721 "close the inotify handle",
3723 This closes the inotify handle which was previously
3724 opened by inotify_init. It removes all watches, throws
3725 away any pending events, and deallocates all resources.");
3727 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3729 "set SELinux security context",
3731 This sets the SELinux security context of the daemon
3732 to the string C<context>.
3734 See the documentation about SELINUX in L<guestfs(3)>.");
3736 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3738 "get SELinux security context",
3740 This gets the SELinux security context of the daemon.
3742 See the documentation about SELINUX in L<guestfs(3)>,
3743 and C<guestfs_setcon>");
3745 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3746 [InitEmpty, Always, TestOutput (
3747 [["part_disk"; "/dev/sda"; "mbr"];
3748 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3749 ["mount_options"; ""; "/dev/sda1"; "/"];
3750 ["write"; "/new"; "new file contents"];
3751 ["cat"; "/new"]], "new file contents");
3752 InitEmpty, Always, TestRun (
3753 [["part_disk"; "/dev/sda"; "mbr"];
3754 ["mkfs_b"; "vfat"; "32768"; "/dev/sda1"]]);
3755 InitEmpty, Always, TestLastFail (
3756 [["part_disk"; "/dev/sda"; "mbr"];
3757 ["mkfs_b"; "vfat"; "32769"; "/dev/sda1"]]);
3758 InitEmpty, Always, TestLastFail (
3759 [["part_disk"; "/dev/sda"; "mbr"];
3760 ["mkfs_b"; "vfat"; "33280"; "/dev/sda1"]]);
3761 InitEmpty, IfAvailable "ntfsprogs", TestRun (
3762 [["part_disk"; "/dev/sda"; "mbr"];
3763 ["mkfs_b"; "ntfs"; "32768"; "/dev/sda1"]])],
3764 "make a filesystem with block size",
3766 This call is similar to C<guestfs_mkfs>, but it allows you to
3767 control the block size of the resulting filesystem. Supported
3768 block sizes depend on the filesystem type, but typically they
3769 are C<1024>, C<2048> or C<4096> only.
3771 For VFAT and NTFS the C<blocksize> parameter is treated as
3772 the requested cluster size.");
3774 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3775 [InitEmpty, Always, TestOutput (
3776 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3777 ["mke2journal"; "4096"; "/dev/sda1"];
3778 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3779 ["mount_options"; ""; "/dev/sda2"; "/"];
3780 ["write"; "/new"; "new file contents"];
3781 ["cat"; "/new"]], "new file contents")],
3782 "make ext2/3/4 external journal",
3784 This creates an ext2 external journal on C<device>. It is equivalent
3787 mke2fs -O journal_dev -b blocksize device");
3789 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3790 [InitEmpty, Always, TestOutput (
3791 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3792 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3793 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3794 ["mount_options"; ""; "/dev/sda2"; "/"];
3795 ["write"; "/new"; "new file contents"];
3796 ["cat"; "/new"]], "new file contents")],
3797 "make ext2/3/4 external journal with label",
3799 This creates an ext2 external journal on C<device> with label C<label>.");
3801 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3802 (let uuid = uuidgen () in
3803 [InitEmpty, Always, TestOutput (
3804 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3805 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3806 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3807 ["mount_options"; ""; "/dev/sda2"; "/"];
3808 ["write"; "/new"; "new file contents"];
3809 ["cat"; "/new"]], "new file contents")]),
3810 "make ext2/3/4 external journal with UUID",
3812 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3814 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3816 "make ext2/3/4 filesystem with external journal",
3818 This creates an ext2/3/4 filesystem on C<device> with
3819 an external journal on C<journal>. It is equivalent
3822 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3824 See also C<guestfs_mke2journal>.");
3826 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3828 "make ext2/3/4 filesystem with external journal",
3830 This creates an ext2/3/4 filesystem on C<device> with
3831 an external journal on the journal labeled C<label>.
3833 See also C<guestfs_mke2journal_L>.");
3835 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3837 "make ext2/3/4 filesystem with external journal",
3839 This creates an ext2/3/4 filesystem on C<device> with
3840 an external journal on the journal with UUID C<uuid>.
3842 See also C<guestfs_mke2journal_U>.");
3844 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3845 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3846 "load a kernel module",
3848 This loads a kernel module in the appliance.
3850 The kernel module must have been whitelisted when libguestfs
3851 was built (see C<appliance/kmod.whitelist.in> in the source).");
3853 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3854 [InitNone, Always, TestOutput (
3855 [["echo_daemon"; "This is a test"]], "This is a test"
3857 "echo arguments back to the client",
3859 This command concatenates the list of C<words> passed with single spaces
3860 between them and returns the resulting string.
3862 You can use this command to test the connection through to the daemon.
3864 See also C<guestfs_ping_daemon>.");
3866 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3867 [], (* There is a regression test for this. *)
3868 "find all files and directories, returning NUL-separated list",
3870 This command lists out all files and directories, recursively,
3871 starting at C<directory>, placing the resulting list in the
3872 external file called C<files>.
3874 This command works the same way as C<guestfs_find> with the
3875 following exceptions:
3881 The resulting list is written to an external file.
3885 Items (filenames) in the result are separated
3886 by C<\\0> characters. See L<find(1)> option I<-print0>.
3890 This command is not limited in the number of names that it
3895 The result list is not sorted.
3899 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3900 [InitISOFS, Always, TestOutput (
3901 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3902 InitISOFS, Always, TestOutput (
3903 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3904 InitISOFS, Always, TestOutput (
3905 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3906 InitISOFS, Always, TestLastFail (
3907 [["case_sensitive_path"; "/Known-1/"]]);
3908 InitBasicFS, Always, TestOutput (
3910 ["mkdir"; "/a/bbb"];
3911 ["touch"; "/a/bbb/c"];
3912 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3913 InitBasicFS, Always, TestOutput (
3915 ["mkdir"; "/a/bbb"];
3916 ["touch"; "/a/bbb/c"];
3917 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3918 InitBasicFS, Always, TestLastFail (
3920 ["mkdir"; "/a/bbb"];
3921 ["touch"; "/a/bbb/c"];
3922 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3923 "return true path on case-insensitive filesystem",
3925 This can be used to resolve case insensitive paths on
3926 a filesystem which is case sensitive. The use case is
3927 to resolve paths which you have read from Windows configuration
3928 files or the Windows Registry, to the true path.
3930 The command handles a peculiarity of the Linux ntfs-3g
3931 filesystem driver (and probably others), which is that although
3932 the underlying filesystem is case-insensitive, the driver
3933 exports the filesystem to Linux as case-sensitive.
3935 One consequence of this is that special directories such
3936 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3937 (or other things) depending on the precise details of how
3938 they were created. In Windows itself this would not be
3941 Bug or feature? You decide:
3942 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3944 This function resolves the true case of each element in the
3945 path and returns the case-sensitive path.
3947 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3948 might return C<\"/WINDOWS/system32\"> (the exact return value
3949 would depend on details of how the directories were originally
3950 created under Windows).
3953 This function does not handle drive names, backslashes etc.
3955 See also C<guestfs_realpath>.");
3957 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3958 [InitBasicFS, Always, TestOutput (
3959 [["vfs_type"; "/dev/sda1"]], "ext2")],
3960 "get the Linux VFS type corresponding to a mounted device",
3962 This command gets the filesystem type corresponding to
3963 the filesystem on C<device>.
3965 For most filesystems, the result is the name of the Linux
3966 VFS module which would be used to mount this filesystem
3967 if you mounted it without specifying the filesystem type.
3968 For example a string such as C<ext3> or C<ntfs>.");
3970 ("truncate", (RErr, [Pathname "path"]), 199, [],
3971 [InitBasicFS, Always, TestOutputStruct (
3972 [["write"; "/test"; "some stuff so size is not zero"];
3973 ["truncate"; "/test"];
3974 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3975 "truncate a file to zero size",
3977 This command truncates C<path> to a zero-length file. The
3978 file must exist already.");
3980 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3981 [InitBasicFS, Always, TestOutputStruct (
3982 [["touch"; "/test"];
3983 ["truncate_size"; "/test"; "1000"];
3984 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3985 "truncate a file to a particular size",
3987 This command truncates C<path> to size C<size> bytes. The file
3990 If the current file size is less than C<size> then
3991 the file is extended to the required size with zero bytes.
3992 This creates a sparse file (ie. disk blocks are not allocated
3993 for the file until you write to it). To create a non-sparse
3994 file of zeroes, use C<guestfs_fallocate64> instead.");
3996 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3997 [InitBasicFS, Always, TestOutputStruct (
3998 [["touch"; "/test"];
3999 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
4000 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
4001 "set timestamp of a file with nanosecond precision",
4003 This command sets the timestamps of a file with nanosecond
4006 C<atsecs, atnsecs> are the last access time (atime) in secs and
4007 nanoseconds from the epoch.
4009 C<mtsecs, mtnsecs> are the last modification time (mtime) in
4010 secs and nanoseconds from the epoch.
4012 If the C<*nsecs> field contains the special value C<-1> then
4013 the corresponding timestamp is set to the current time. (The
4014 C<*secs> field is ignored in this case).
4016 If the C<*nsecs> field contains the special value C<-2> then
4017 the corresponding timestamp is left unchanged. (The
4018 C<*secs> field is ignored in this case).");
4020 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
4021 [InitBasicFS, Always, TestOutputStruct (
4022 [["mkdir_mode"; "/test"; "0o111"];
4023 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
4024 "create a directory with a particular mode",
4026 This command creates a directory, setting the initial permissions
4027 of the directory to C<mode>.
4029 For common Linux filesystems, the actual mode which is set will
4030 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
4031 interpret the mode in other ways.
4033 See also C<guestfs_mkdir>, C<guestfs_umask>");
4035 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
4037 "change file owner and group",
4039 Change the file owner to C<owner> and group to C<group>.
4040 This is like C<guestfs_chown> but if C<path> is a symlink then
4041 the link itself is changed, not the target.
4043 Only numeric uid and gid are supported. If you want to use
4044 names, you will need to locate and parse the password file
4045 yourself (Augeas support makes this relatively easy).");
4047 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
4049 "lstat on multiple files",
4051 This call allows you to perform the C<guestfs_lstat> operation
4052 on multiple files, where all files are in the directory C<path>.
4053 C<names> is the list of files from this directory.
4055 On return you get a list of stat structs, with a one-to-one
4056 correspondence to the C<names> list. If any name did not exist
4057 or could not be lstat'd, then the C<ino> field of that structure
4060 This call is intended for programs that want to efficiently
4061 list a directory contents without making many round-trips.
4062 See also C<guestfs_lxattrlist> for a similarly efficient call
4063 for getting extended attributes. Very long directory listings
4064 might cause the protocol message size to be exceeded, causing
4065 this call to fail. The caller must split up such requests
4066 into smaller groups of names.");
4068 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4070 "lgetxattr on multiple files",
4072 This call allows you to get the extended attributes
4073 of multiple files, where all files are in the directory C<path>.
4074 C<names> is the list of files from this directory.
4076 On return you get a flat list of xattr structs which must be
4077 interpreted sequentially. The first xattr struct always has a zero-length
4078 C<attrname>. C<attrval> in this struct is zero-length
4079 to indicate there was an error doing C<lgetxattr> for this
4080 file, I<or> is a C string which is a decimal number
4081 (the number of following attributes for this file, which could
4082 be C<\"0\">). Then after the first xattr struct are the
4083 zero or more attributes for the first named file.
4084 This repeats for the second and subsequent files.
4086 This call is intended for programs that want to efficiently
4087 list a directory contents without making many round-trips.
4088 See also C<guestfs_lstatlist> for a similarly efficient call
4089 for getting standard stats. Very long directory listings
4090 might cause the protocol message size to be exceeded, causing
4091 this call to fail. The caller must split up such requests
4092 into smaller groups of names.");
4094 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4096 "readlink on multiple files",
4098 This call allows you to do a C<readlink> operation
4099 on multiple files, where all files are in the directory C<path>.
4100 C<names> is the list of files from this directory.
4102 On return you get a list of strings, with a one-to-one
4103 correspondence to the C<names> list. Each string is the
4104 value of the symbolic link.
4106 If the C<readlink(2)> operation fails on any name, then
4107 the corresponding result string is the empty string C<\"\">.
4108 However the whole operation is completed even if there
4109 were C<readlink(2)> errors, and so you can call this
4110 function with names where you don't know if they are
4111 symbolic links already (albeit slightly less efficient).
4113 This call is intended for programs that want to efficiently
4114 list a directory contents without making many round-trips.
4115 Very long directory listings might cause the protocol
4116 message size to be exceeded, causing
4117 this call to fail. The caller must split up such requests
4118 into smaller groups of names.");
4120 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4121 [InitISOFS, Always, TestOutputBuffer (
4122 [["pread"; "/known-4"; "1"; "3"]], "\n");
4123 InitISOFS, Always, TestOutputBuffer (
4124 [["pread"; "/empty"; "0"; "100"]], "")],
4125 "read part of a file",
4127 This command lets you read part of a file. It reads C<count>
4128 bytes of the file, starting at C<offset>, from file C<path>.
4130 This may read fewer bytes than requested. For further details
4131 see the L<pread(2)> system call.
4133 See also C<guestfs_pwrite>.");
4135 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4136 [InitEmpty, Always, TestRun (
4137 [["part_init"; "/dev/sda"; "gpt"]])],
4138 "create an empty partition table",
4140 This creates an empty partition table on C<device> of one of the
4141 partition types listed below. Usually C<parttype> should be
4142 either C<msdos> or C<gpt> (for large disks).
4144 Initially there are no partitions. Following this, you should
4145 call C<guestfs_part_add> for each partition required.
4147 Possible values for C<parttype> are:
4151 =item B<efi> | B<gpt>
4153 Intel EFI / GPT partition table.
4155 This is recommended for >= 2 TB partitions that will be accessed
4156 from Linux and Intel-based Mac OS X. It also has limited backwards
4157 compatibility with the C<mbr> format.
4159 =item B<mbr> | B<msdos>
4161 The standard PC \"Master Boot Record\" (MBR) format used
4162 by MS-DOS and Windows. This partition type will B<only> work
4163 for device sizes up to 2 TB. For large disks we recommend
4168 Other partition table types that may work but are not
4177 =item B<amiga> | B<rdb>
4179 Amiga \"Rigid Disk Block\" format.
4187 DASD, used on IBM mainframes.
4195 Old Mac partition format. Modern Macs use C<gpt>.
4199 NEC PC-98 format, common in Japan apparently.
4207 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4208 [InitEmpty, Always, TestRun (
4209 [["part_init"; "/dev/sda"; "mbr"];
4210 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4211 InitEmpty, Always, TestRun (
4212 [["part_init"; "/dev/sda"; "gpt"];
4213 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4214 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4215 InitEmpty, Always, TestRun (
4216 [["part_init"; "/dev/sda"; "mbr"];
4217 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4218 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4219 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4220 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4221 "add a partition to the device",
4223 This command adds a partition to C<device>. If there is no partition
4224 table on the device, call C<guestfs_part_init> first.
4226 The C<prlogex> parameter is the type of partition. Normally you
4227 should pass C<p> or C<primary> here, but MBR partition tables also
4228 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4231 C<startsect> and C<endsect> are the start and end of the partition
4232 in I<sectors>. C<endsect> may be negative, which means it counts
4233 backwards from the end of the disk (C<-1> is the last sector).
4235 Creating a partition which covers the whole disk is not so easy.
4236 Use C<guestfs_part_disk> to do that.");
4238 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4239 [InitEmpty, Always, TestRun (
4240 [["part_disk"; "/dev/sda"; "mbr"]]);
4241 InitEmpty, Always, TestRun (
4242 [["part_disk"; "/dev/sda"; "gpt"]])],
4243 "partition whole disk with a single primary partition",
4245 This command is simply a combination of C<guestfs_part_init>
4246 followed by C<guestfs_part_add> to create a single primary partition
4247 covering the whole disk.
4249 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4250 but other possible values are described in C<guestfs_part_init>.");
4252 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4253 [InitEmpty, Always, TestRun (
4254 [["part_disk"; "/dev/sda"; "mbr"];
4255 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4256 "make a partition bootable",
4258 This sets the bootable flag on partition numbered C<partnum> on
4259 device C<device>. Note that partitions are numbered from 1.
4261 The bootable flag is used by some operating systems (notably
4262 Windows) to determine which partition to boot from. It is by
4263 no means universally recognized.");
4265 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4266 [InitEmpty, Always, TestRun (
4267 [["part_disk"; "/dev/sda"; "gpt"];
4268 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4269 "set partition name",
4271 This sets the partition name on partition numbered C<partnum> on
4272 device C<device>. Note that partitions are numbered from 1.
4274 The partition name can only be set on certain types of partition
4275 table. This works on C<gpt> but not on C<mbr> partitions.");
4277 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4278 [], (* XXX Add a regression test for this. *)
4279 "list partitions on a device",
4281 This command parses the partition table on C<device> and
4282 returns the list of partitions found.
4284 The fields in the returned structure are:
4290 Partition number, counting from 1.
4294 Start of the partition I<in bytes>. To get sectors you have to
4295 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4299 End of the partition in bytes.
4303 Size of the partition in bytes.
4307 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4308 [InitEmpty, Always, TestOutput (
4309 [["part_disk"; "/dev/sda"; "gpt"];
4310 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4311 "get the partition table type",
4313 This command examines the partition table on C<device> and
4314 returns the partition table type (format) being used.
4316 Common return values include: C<msdos> (a DOS/Windows style MBR
4317 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4318 values are possible, although unusual. See C<guestfs_part_init>
4321 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4322 [InitBasicFS, Always, TestOutputBuffer (
4323 [["fill"; "0x63"; "10"; "/test"];
4324 ["read_file"; "/test"]], "cccccccccc")],
4325 "fill a file with octets",
4327 This command creates a new file called C<path>. The initial
4328 content of the file is C<len> octets of C<c>, where C<c>
4329 must be a number in the range C<[0..255]>.
4331 To fill a file with zero bytes (sparsely), it is
4332 much more efficient to use C<guestfs_truncate_size>.
4333 To create a file with a pattern of repeating bytes
4334 use C<guestfs_fill_pattern>.");
4336 ("available", (RErr, [StringList "groups"]), 216, [],
4337 [InitNone, Always, TestRun [["available"; ""]]],
4338 "test availability of some parts of the API",
4340 This command is used to check the availability of some
4341 groups of functionality in the appliance, which not all builds of
4342 the libguestfs appliance will be able to provide.
4344 The libguestfs groups, and the functions that those
4345 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4346 You can also fetch this list at runtime by calling
4347 C<guestfs_available_all_groups>.
4349 The argument C<groups> is a list of group names, eg:
4350 C<[\"inotify\", \"augeas\"]> would check for the availability of
4351 the Linux inotify functions and Augeas (configuration file
4354 The command returns no error if I<all> requested groups are available.
4356 It fails with an error if one or more of the requested
4357 groups is unavailable in the appliance.
4359 If an unknown group name is included in the
4360 list of groups then an error is always returned.
4368 You must call C<guestfs_launch> before calling this function.
4370 The reason is because we don't know what groups are
4371 supported by the appliance/daemon until it is running and can
4376 If a group of functions is available, this does not necessarily
4377 mean that they will work. You still have to check for errors
4378 when calling individual API functions even if they are
4383 It is usually the job of distro packagers to build
4384 complete functionality into the libguestfs appliance.
4385 Upstream libguestfs, if built from source with all
4386 requirements satisfied, will support everything.
4390 This call was added in version C<1.0.80>. In previous
4391 versions of libguestfs all you could do would be to speculatively
4392 execute a command to find out if the daemon implemented it.
4393 See also C<guestfs_version>.
4397 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4398 [InitBasicFS, Always, TestOutputBuffer (
4399 [["write"; "/src"; "hello, world"];
4400 ["dd"; "/src"; "/dest"];
4401 ["read_file"; "/dest"]], "hello, world")],
4402 "copy from source to destination using dd",
4404 This command copies from one source device or file C<src>
4405 to another destination device or file C<dest>. Normally you
4406 would use this to copy to or from a device or partition, for
4407 example to duplicate a filesystem.
4409 If the destination is a device, it must be as large or larger
4410 than the source file or device, otherwise the copy will fail.
4411 This command cannot do partial copies (see C<guestfs_copy_size>).");
4413 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4414 [InitBasicFS, Always, TestOutputInt (
4415 [["write"; "/file"; "hello, world"];
4416 ["filesize"; "/file"]], 12)],
4417 "return the size of the file in bytes",
4419 This command returns the size of C<file> in bytes.
4421 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4422 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4423 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4425 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4426 [InitBasicFSonLVM, Always, TestOutputList (
4427 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4428 ["lvs"]], ["/dev/VG/LV2"])],
4429 "rename an LVM logical volume",
4431 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4433 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4434 [InitBasicFSonLVM, Always, TestOutputList (
4436 ["vg_activate"; "false"; "VG"];
4437 ["vgrename"; "VG"; "VG2"];
4438 ["vg_activate"; "true"; "VG2"];
4439 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4440 ["vgs"]], ["VG2"])],
4441 "rename an LVM volume group",
4443 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4445 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4446 [InitISOFS, Always, TestOutputBuffer (
4447 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4448 "list the contents of a single file in an initrd",
4450 This command unpacks the file C<filename> from the initrd file
4451 called C<initrdpath>. The filename must be given I<without> the
4452 initial C</> character.
4454 For example, in guestfish you could use the following command
4455 to examine the boot script (usually called C</init>)
4456 contained in a Linux initrd or initramfs image:
4458 initrd-cat /boot/initrd-<version>.img init
4460 See also C<guestfs_initrd_list>.");
4462 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4464 "get the UUID of a physical volume",
4466 This command returns the UUID of the LVM PV C<device>.");
4468 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4470 "get the UUID of a volume group",
4472 This command returns the UUID of the LVM VG named C<vgname>.");
4474 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4476 "get the UUID of a logical volume",
4478 This command returns the UUID of the LVM LV C<device>.");
4480 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4482 "get the PV UUIDs containing the volume group",
4484 Given a VG called C<vgname>, this returns the UUIDs of all
4485 the physical volumes that this volume group resides on.
4487 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4488 calls to associate physical volumes and volume groups.
4490 See also C<guestfs_vglvuuids>.");
4492 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4494 "get the LV UUIDs of all LVs in the volume group",
4496 Given a VG called C<vgname>, this returns the UUIDs of all
4497 the logical volumes created in this volume group.
4499 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4500 calls to associate logical volumes and volume groups.
4502 See also C<guestfs_vgpvuuids>.");
4504 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4505 [InitBasicFS, Always, TestOutputBuffer (
4506 [["write"; "/src"; "hello, world"];
4507 ["copy_size"; "/src"; "/dest"; "5"];
4508 ["read_file"; "/dest"]], "hello")],
4509 "copy size bytes from source to destination using dd",
4511 This command copies exactly C<size> bytes from one source device
4512 or file C<src> to another destination device or file C<dest>.
4514 Note this will fail if the source is too short or if the destination
4515 is not large enough.");
4517 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4518 [InitBasicFSonLVM, Always, TestRun (
4519 [["zero_device"; "/dev/VG/LV"]])],
4520 "write zeroes to an entire device",
4522 This command writes zeroes over the entire C<device>. Compare
4523 with C<guestfs_zero> which just zeroes the first few blocks of
4526 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [Optional "xz"],
4527 [InitBasicFS, Always, TestOutput (
4528 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4529 ["cat"; "/hello"]], "hello\n")],
4530 "unpack compressed tarball to directory",
4532 This command uploads and unpacks local file C<tarball> (an
4533 I<xz compressed> tar file) into C<directory>.");
4535 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [Optional "xz"],
4537 "pack directory into compressed tarball",
4539 This command packs the contents of C<directory> and downloads
4540 it to local file C<tarball> (as an xz compressed tar archive).");
4542 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4544 "resize an NTFS filesystem",
4546 This command resizes an NTFS filesystem, expanding or
4547 shrinking it to the size of the underlying device.
4548 See also L<ntfsresize(8)>.");
4550 ("vgscan", (RErr, []), 232, [],
4551 [InitEmpty, Always, TestRun (
4553 "rescan for LVM physical volumes, volume groups and logical volumes",
4555 This rescans all block devices and rebuilds the list of LVM
4556 physical volumes, volume groups and logical volumes.");
4558 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4559 [InitEmpty, Always, TestRun (
4560 [["part_init"; "/dev/sda"; "mbr"];
4561 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4562 ["part_del"; "/dev/sda"; "1"]])],
4563 "delete a partition",
4565 This command deletes the partition numbered C<partnum> on C<device>.
4567 Note that in the case of MBR partitioning, deleting an
4568 extended partition also deletes any logical partitions
4571 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4572 [InitEmpty, Always, TestOutputTrue (
4573 [["part_init"; "/dev/sda"; "mbr"];
4574 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4575 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4576 ["part_get_bootable"; "/dev/sda"; "1"]])],
4577 "return true if a partition is bootable",
4579 This command returns true if the partition C<partnum> on
4580 C<device> has the bootable flag set.
4582 See also C<guestfs_part_set_bootable>.");
4584 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4585 [InitEmpty, Always, TestOutputInt (
4586 [["part_init"; "/dev/sda"; "mbr"];
4587 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4588 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4589 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4590 "get the MBR type byte (ID byte) from a partition",
4592 Returns the MBR type byte (also known as the ID byte) from
4593 the numbered partition C<partnum>.
4595 Note that only MBR (old DOS-style) partitions have type bytes.
4596 You will get undefined results for other partition table
4597 types (see C<guestfs_part_get_parttype>).");
4599 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4600 [], (* tested by part_get_mbr_id *)
4601 "set the MBR type byte (ID byte) of a partition",
4603 Sets the MBR type byte (also known as the ID byte) of
4604 the numbered partition C<partnum> to C<idbyte>. Note
4605 that the type bytes quoted in most documentation are
4606 in fact hexadecimal numbers, but usually documented
4607 without any leading \"0x\" which might be confusing.
4609 Note that only MBR (old DOS-style) partitions have type bytes.
4610 You will get undefined results for other partition table
4611 types (see C<guestfs_part_get_parttype>).");
4613 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4614 [InitISOFS, Always, TestOutput (
4615 [["checksum_device"; "md5"; "/dev/sdd"]],
4616 (Digest.to_hex (Digest.file "images/test.iso")))],
4617 "compute MD5, SHAx or CRC checksum of the contents of a device",
4619 This call computes the MD5, SHAx or CRC checksum of the
4620 contents of the device named C<device>. For the types of
4621 checksums supported see the C<guestfs_checksum> command.");
4623 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4624 [InitNone, Always, TestRun (
4625 [["part_disk"; "/dev/sda"; "mbr"];
4626 ["pvcreate"; "/dev/sda1"];
4627 ["vgcreate"; "VG"; "/dev/sda1"];
4628 ["lvcreate"; "LV"; "VG"; "10"];
4629 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4630 "expand an LV to fill free space",
4632 This expands an existing logical volume C<lv> so that it fills
4633 C<pc>% of the remaining free space in the volume group. Commonly
4634 you would call this with pc = 100 which expands the logical volume
4635 as much as possible, using all remaining free space in the volume
4638 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4639 [], (* XXX Augeas code needs tests. *)
4640 "clear Augeas path",
4642 Set the value associated with C<path> to C<NULL>. This
4643 is the same as the L<augtool(1)> C<clear> command.");
4645 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
4646 [InitEmpty, Always, TestOutputInt (
4647 [["get_umask"]], 0o22)],
4648 "get the current umask",
4650 Return the current umask. By default the umask is C<022>
4651 unless it has been set by calling C<guestfs_umask>.");
4653 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
4655 "upload a file to the appliance (internal use only)",
4657 The C<guestfs_debug_upload> command uploads a file to
4658 the libguestfs appliance.
4660 There is no comprehensive help for this command. You have
4661 to look at the file C<daemon/debug.c> in the libguestfs source
4662 to find out what it is for.");
4664 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
4665 [InitBasicFS, Always, TestOutput (
4666 [["base64_in"; "../images/hello.b64"; "/hello"];
4667 ["cat"; "/hello"]], "hello\n")],
4668 "upload base64-encoded data to file",
4670 This command uploads base64-encoded data from C<base64file>
4673 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
4675 "download file and encode as base64",
4677 This command downloads the contents of C<filename>, writing
4678 it out to local file C<base64file> encoded as base64.");
4680 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
4682 "compute MD5, SHAx or CRC checksum of files in a directory",
4684 This command computes the checksums of all regular files in
4685 C<directory> and then emits a list of those checksums to
4686 the local output file C<sumsfile>.
4688 This can be used for verifying the integrity of a virtual
4689 machine. However to be properly secure you should pay
4690 attention to the output of the checksum command (it uses
4691 the ones from GNU coreutils). In particular when the
4692 filename is not printable, coreutils uses a special
4693 backslash syntax. For more information, see the GNU
4694 coreutils info file.");
4696 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
4697 [InitBasicFS, Always, TestOutputBuffer (
4698 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4699 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4700 "fill a file with a repeating pattern of bytes",
4702 This function is like C<guestfs_fill> except that it creates
4703 a new file of length C<len> containing the repeating pattern
4704 of bytes in C<pattern>. The pattern is truncated if necessary
4705 to ensure the length of the file is exactly C<len> bytes.");
4707 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
4708 [InitBasicFS, Always, TestOutput (
4709 [["write"; "/new"; "new file contents"];
4710 ["cat"; "/new"]], "new file contents");
4711 InitBasicFS, Always, TestOutput (
4712 [["write"; "/new"; "\nnew file contents\n"];
4713 ["cat"; "/new"]], "\nnew file contents\n");
4714 InitBasicFS, Always, TestOutput (
4715 [["write"; "/new"; "\n\n"];
4716 ["cat"; "/new"]], "\n\n");
4717 InitBasicFS, Always, TestOutput (
4718 [["write"; "/new"; ""];
4719 ["cat"; "/new"]], "");
4720 InitBasicFS, Always, TestOutput (
4721 [["write"; "/new"; "\n\n\n"];
4722 ["cat"; "/new"]], "\n\n\n");
4723 InitBasicFS, Always, TestOutput (
4724 [["write"; "/new"; "\n"];
4725 ["cat"; "/new"]], "\n")],
4726 "create a new file",
4728 This call creates a file called C<path>. The content of the
4729 file is the string C<content> (which can contain any 8 bit data).");
4731 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
4732 [InitBasicFS, Always, TestOutput (
4733 [["write"; "/new"; "new file contents"];
4734 ["pwrite"; "/new"; "data"; "4"];
4735 ["cat"; "/new"]], "new data contents");
4736 InitBasicFS, Always, TestOutput (
4737 [["write"; "/new"; "new file contents"];
4738 ["pwrite"; "/new"; "is extended"; "9"];
4739 ["cat"; "/new"]], "new file is extended");
4740 InitBasicFS, Always, TestOutput (
4741 [["write"; "/new"; "new file contents"];
4742 ["pwrite"; "/new"; ""; "4"];
4743 ["cat"; "/new"]], "new file contents")],
4744 "write to part of a file",
4746 This command writes to part of a file. It writes the data
4747 buffer C<content> to the file C<path> starting at offset C<offset>.
4749 This command implements the L<pwrite(2)> system call, and like
4750 that system call it may not write the full data requested. The
4751 return value is the number of bytes that were actually written
4752 to the file. This could even be 0, although short writes are
4753 unlikely for regular files in ordinary circumstances.
4755 See also C<guestfs_pread>.");
4757 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
4759 "resize an ext2, ext3 or ext4 filesystem (with size)",
4761 This command is the same as C<guestfs_resize2fs> except that it
4762 allows you to specify the new size (in bytes) explicitly.");
4764 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
4766 "resize an LVM physical volume (with size)",
4768 This command is the same as C<guestfs_pvresize> except that it
4769 allows you to specify the new size (in bytes) explicitly.");
4771 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"]), 250, [Optional "ntfsprogs"],
4773 "resize an NTFS filesystem (with size)",
4775 This command is the same as C<guestfs_ntfsresize> except that it
4776 allows you to specify the new size (in bytes) explicitly.");
4778 ("available_all_groups", (RStringList "groups", []), 251, [],
4779 [InitNone, Always, TestRun [["available_all_groups"]]],
4780 "return a list of all optional groups",
4782 This command returns a list of all optional groups that this
4783 daemon knows about. Note this returns both supported and unsupported
4784 groups. To find out which ones the daemon can actually support
4785 you have to call C<guestfs_available> on each member of the
4788 See also C<guestfs_available> and L<guestfs(3)/AVAILABILITY>.");
4790 ("fallocate64", (RErr, [Pathname "path"; Int64 "len"]), 252, [],
4791 [InitBasicFS, Always, TestOutputStruct (
4792 [["fallocate64"; "/a"; "1000000"];
4793 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
4794 "preallocate a file in the guest filesystem",
4796 This command preallocates a file (containing zero bytes) named
4797 C<path> of size C<len> bytes. If the file exists already, it
4800 Note that this call allocates disk blocks for the file.
4801 To create a sparse file use C<guestfs_truncate_size> instead.
4803 The deprecated call C<guestfs_fallocate> does the same,
4804 but owing to an oversight it only allowed 30 bit lengths
4805 to be specified, effectively limiting the maximum size
4806 of files created through that call to 1GB.
4808 Do not confuse this with the guestfish-specific
4809 C<alloc> and C<sparse> commands which create
4810 a file in the host and attach it as a device.");
4812 ("vfs_label", (RString "label", [Device "device"]), 253, [],
4813 [InitBasicFS, Always, TestOutput (
4814 [["set_e2label"; "/dev/sda1"; "LTEST"];
4815 ["vfs_label"; "/dev/sda1"]], "LTEST")],
4816 "get the filesystem label",
4818 This returns the filesystem label of the filesystem on
4821 If the filesystem is unlabeled, this returns the empty string.");
4823 ("vfs_uuid", (RString "uuid", [Device "device"]), 254, [],
4824 (let uuid = uuidgen () in
4825 [InitBasicFS, Always, TestOutput (
4826 [["set_e2uuid"; "/dev/sda1"; uuid];
4827 ["vfs_uuid"; "/dev/sda1"]], uuid)]),
4828 "get the filesystem UUID",
4830 This returns the filesystem UUID of the filesystem on
4833 If the filesystem does not have a UUID, this returns the empty string.");
4837 let all_functions = non_daemon_functions @ daemon_functions
4839 (* In some places we want the functions to be displayed sorted
4840 * alphabetically, so this is useful:
4842 let all_functions_sorted =
4843 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4844 compare n1 n2) all_functions
4846 (* This is used to generate the src/MAX_PROC_NR file which
4847 * contains the maximum procedure number, a surrogate for the
4848 * ABI version number. See src/Makefile.am for the details.
4851 let proc_nrs = List.map (
4852 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4853 ) daemon_functions in
4854 List.fold_left max 0 proc_nrs
4856 (* Field types for structures. *)
4858 | FChar (* C 'char' (really, a 7 bit byte). *)
4859 | FString (* nul-terminated ASCII string, NOT NULL. *)
4860 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4865 | FBytes (* Any int measure that counts bytes. *)
4866 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4867 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4869 (* Because we generate extra parsing code for LVM command line tools,
4870 * we have to pull out the LVM columns separately here.
4880 "pv_attr", FString (* XXX *);
4881 "pv_pe_count", FInt64;
4882 "pv_pe_alloc_count", FInt64;
4885 "pv_mda_count", FInt64;
4886 "pv_mda_free", FBytes;
4887 (* Not in Fedora 10:
4888 "pv_mda_size", FBytes;
4895 "vg_attr", FString (* XXX *);
4898 "vg_sysid", FString;
4899 "vg_extent_size", FBytes;
4900 "vg_extent_count", FInt64;
4901 "vg_free_count", FInt64;
4906 "snap_count", FInt64;
4909 "vg_mda_count", FInt64;
4910 "vg_mda_free", FBytes;
4911 (* Not in Fedora 10:
4912 "vg_mda_size", FBytes;
4918 "lv_attr", FString (* XXX *);
4921 "lv_kernel_major", FInt64;
4922 "lv_kernel_minor", FInt64;
4924 "seg_count", FInt64;
4926 "snap_percent", FOptPercent;
4927 "copy_percent", FOptPercent;
4930 "mirror_log", FString;
4934 (* Names and fields in all structures (in RStruct and RStructList)
4938 (* The old RIntBool return type, only ever used for aug_defnode. Do
4939 * not use this struct in any new code.
4942 "i", FInt32; (* for historical compatibility *)
4943 "b", FInt32; (* for historical compatibility *)
4946 (* LVM PVs, VGs, LVs. *)
4947 "lvm_pv", lvm_pv_cols;
4948 "lvm_vg", lvm_vg_cols;
4949 "lvm_lv", lvm_lv_cols;
4951 (* Column names and types from stat structures.
4952 * NB. Can't use things like 'st_atime' because glibc header files
4953 * define some of these as macros. Ugh.
4984 (* Column names in dirent structure. *)
4987 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4992 (* Version numbers. *)
5000 (* Extended attribute. *)
5002 "attrname", FString;
5006 (* Inotify events. *)
5010 "in_cookie", FUInt32;
5014 (* Partition table entry. *)
5017 "part_start", FBytes;
5019 "part_size", FBytes;
5021 ] (* end of structs *)
5023 (* Ugh, Java has to be different ..
5024 * These names are also used by the Haskell bindings.
5026 let java_structs = [
5027 "int_bool", "IntBool";
5032 "statvfs", "StatVFS";
5034 "version", "Version";
5036 "inotify_event", "INotifyEvent";
5037 "partition", "Partition";
5040 (* What structs are actually returned. *)
5041 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
5043 (* Returns a list of RStruct/RStructList structs that are returned
5044 * by any function. Each element of returned list is a pair:
5046 * (structname, RStructOnly)
5047 * == there exists function which returns RStruct (_, structname)
5048 * (structname, RStructListOnly)
5049 * == there exists function which returns RStructList (_, structname)
5050 * (structname, RStructAndList)
5051 * == there are functions returning both RStruct (_, structname)
5052 * and RStructList (_, structname)
5054 let rstructs_used_by functions =
5055 (* ||| is a "logical OR" for rstructs_used_t *)
5059 | _, RStructAndList -> RStructAndList
5060 | RStructOnly, RStructListOnly
5061 | RStructListOnly, RStructOnly -> RStructAndList
5062 | RStructOnly, RStructOnly -> RStructOnly
5063 | RStructListOnly, RStructListOnly -> RStructListOnly
5066 let h = Hashtbl.create 13 in
5068 (* if elem->oldv exists, update entry using ||| operator,
5069 * else just add elem->newv to the hash
5071 let update elem newv =
5072 try let oldv = Hashtbl.find h elem in
5073 Hashtbl.replace h elem (newv ||| oldv)
5074 with Not_found -> Hashtbl.add h elem newv
5078 fun (_, style, _, _, _, _, _) ->
5079 match fst style with
5080 | RStruct (_, structname) -> update structname RStructOnly
5081 | RStructList (_, structname) -> update structname RStructListOnly
5085 (* return key->values as a list of (key,value) *)
5086 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
5088 (* Used for testing language bindings. *)
5090 | CallString of string
5091 | CallOptString of string option
5092 | CallStringList of string list
5094 | CallInt64 of int64
5096 | CallBuffer of string
5098 (* Used to memoize the result of pod2text. *)
5099 let pod2text_memo_filename = "src/.pod2text.data"
5100 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
5102 let chan = open_in pod2text_memo_filename in
5103 let v = input_value chan in
5107 _ -> Hashtbl.create 13
5108 let pod2text_memo_updated () =
5109 let chan = open_out pod2text_memo_filename in
5110 output_value chan pod2text_memo;
5113 (* Useful functions.
5114 * Note we don't want to use any external OCaml libraries which
5115 * makes this a bit harder than it should be.
5117 module StringMap = Map.Make (String)
5119 let failwithf fs = ksprintf failwith fs
5121 let unique = let i = ref 0 in fun () -> incr i; !i
5123 let replace_char s c1 c2 =
5124 let s2 = String.copy s in
5125 let r = ref false in
5126 for i = 0 to String.length s2 - 1 do
5127 if String.unsafe_get s2 i = c1 then (
5128 String.unsafe_set s2 i c2;
5132 if not !r then s else s2
5136 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5138 let triml ?(test = isspace) str =
5140 let n = ref (String.length str) in
5141 while !n > 0 && test str.[!i]; do
5146 else String.sub str !i !n
5148 let trimr ?(test = isspace) str =
5149 let n = ref (String.length str) in
5150 while !n > 0 && test str.[!n-1]; do
5153 if !n = String.length str then str
5154 else String.sub str 0 !n
5156 let trim ?(test = isspace) str =
5157 trimr ~test (triml ~test str)
5159 let rec find s sub =
5160 let len = String.length s in
5161 let sublen = String.length sub in
5163 if i <= len-sublen then (
5165 if j < sublen then (
5166 if s.[i+j] = sub.[j] then loop2 (j+1)
5172 if r = -1 then loop (i+1) else r
5178 let rec replace_str s s1 s2 =
5179 let len = String.length s in
5180 let sublen = String.length s1 in
5181 let i = find s s1 in
5184 let s' = String.sub s 0 i in
5185 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5186 s' ^ s2 ^ replace_str s'' s1 s2
5189 let rec string_split sep str =
5190 let len = String.length str in
5191 let seplen = String.length sep in
5192 let i = find str sep in
5193 if i = -1 then [str]
5195 let s' = String.sub str 0 i in
5196 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5197 s' :: string_split sep s''
5200 let files_equal n1 n2 =
5201 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5202 match Sys.command cmd with
5205 | i -> failwithf "%s: failed with error code %d" cmd i
5207 let rec filter_map f = function
5211 | Some y -> y :: filter_map f xs
5212 | None -> filter_map f xs
5214 let rec find_map f = function
5215 | [] -> raise Not_found
5219 | None -> find_map f xs
5222 let rec loop i = function
5224 | x :: xs -> f i x; loop (i+1) xs
5229 let rec loop i = function
5231 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5235 let count_chars c str =
5236 let count = ref 0 in
5237 for i = 0 to String.length str - 1 do
5238 if c = String.unsafe_get str i then incr count
5244 for i = 0 to String.length str - 1 do
5245 let c = String.unsafe_get str i in
5250 let map_chars f str =
5251 List.map f (explode str)
5253 let name_of_argt = function
5254 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5255 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5256 | FileIn n | FileOut n | BufferIn n -> n
5258 let java_name_of_struct typ =
5259 try List.assoc typ java_structs
5262 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5264 let cols_of_struct typ =
5265 try List.assoc typ structs
5267 failwithf "cols_of_struct: unknown struct %s" typ
5269 let seq_of_test = function
5270 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5271 | TestOutputListOfDevices (s, _)
5272 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5273 | TestOutputTrue s | TestOutputFalse s
5274 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5275 | TestOutputStruct (s, _)
5276 | TestLastFail s -> s
5278 (* Handling for function flags. *)
5279 let protocol_limit_warning =
5280 "Because of the message protocol, there is a transfer limit
5281 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5283 let danger_will_robinson =
5284 "B<This command is dangerous. Without careful use you
5285 can easily destroy all your data>."
5287 let deprecation_notice flags =
5290 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5292 sprintf "This function is deprecated.
5293 In new code, use the C<%s> call instead.
5295 Deprecated functions will not be removed from the API, but the
5296 fact that they are deprecated indicates that there are problems
5297 with correct use of these functions." alt in
5302 (* Create list of optional groups. *)
5304 let h = Hashtbl.create 13 in
5306 fun (name, _, _, flags, _, _, _) ->
5310 let names = try Hashtbl.find h group with Not_found -> [] in
5311 Hashtbl.replace h group (name :: names)
5315 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5318 fun group -> group, List.sort compare (Hashtbl.find h group)
5320 List.sort (fun x y -> compare (fst x) (fst y)) groups
5322 (* Check function names etc. for consistency. *)
5323 let check_functions () =
5324 let contains_uppercase str =
5325 let len = String.length str in
5327 if i >= len then false
5330 if c >= 'A' && c <= 'Z' then true
5337 (* Check function names. *)
5339 fun (name, _, _, _, _, _, _) ->
5340 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5341 failwithf "function name %s does not need 'guestfs' prefix" name;
5343 failwithf "function name is empty";
5344 if name.[0] < 'a' || name.[0] > 'z' then
5345 failwithf "function name %s must start with lowercase a-z" name;
5346 if String.contains name '-' then
5347 failwithf "function name %s should not contain '-', use '_' instead."
5351 (* Check function parameter/return names. *)
5353 fun (name, style, _, _, _, _, _) ->
5354 let check_arg_ret_name n =
5355 if contains_uppercase n then
5356 failwithf "%s param/ret %s should not contain uppercase chars"
5358 if String.contains n '-' || String.contains n '_' then
5359 failwithf "%s param/ret %s should not contain '-' or '_'"
5362 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;
5363 if n = "int" || n = "char" || n = "short" || n = "long" then
5364 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5365 if n = "i" || n = "n" then
5366 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5367 if n = "argv" || n = "args" then
5368 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5370 (* List Haskell, OCaml and C keywords here.
5371 * http://www.haskell.org/haskellwiki/Keywords
5372 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5373 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5374 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5375 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5376 * Omitting _-containing words, since they're handled above.
5377 * Omitting the OCaml reserved word, "val", is ok,
5378 * and saves us from renaming several parameters.
5381 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5382 "char"; "class"; "const"; "constraint"; "continue"; "data";
5383 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5384 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5385 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5386 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5387 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5389 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5390 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5391 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5392 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5393 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5394 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5395 "volatile"; "when"; "where"; "while";
5397 if List.mem n reserved then
5398 failwithf "%s has param/ret using reserved word %s" name n;
5401 (match fst style with
5403 | RInt n | RInt64 n | RBool n
5404 | RConstString n | RConstOptString n | RString n
5405 | RStringList n | RStruct (n, _) | RStructList (n, _)
5406 | RHashtable n | RBufferOut n ->
5407 check_arg_ret_name n
5409 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5412 (* Check short descriptions. *)
5414 fun (name, _, _, _, _, shortdesc, _) ->
5415 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5416 failwithf "short description of %s should begin with lowercase." name;
5417 let c = shortdesc.[String.length shortdesc-1] in
5418 if c = '\n' || c = '.' then
5419 failwithf "short description of %s should not end with . or \\n." name
5422 (* Check long descriptions. *)
5424 fun (name, _, _, _, _, _, longdesc) ->
5425 if longdesc.[String.length longdesc-1] = '\n' then
5426 failwithf "long description of %s should not end with \\n." name
5429 (* Check proc_nrs. *)
5431 fun (name, _, proc_nr, _, _, _, _) ->
5432 if proc_nr <= 0 then
5433 failwithf "daemon function %s should have proc_nr > 0" name
5437 fun (name, _, proc_nr, _, _, _, _) ->
5438 if proc_nr <> -1 then
5439 failwithf "non-daemon function %s should have proc_nr -1" name
5440 ) non_daemon_functions;
5443 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5446 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5447 let rec loop = function
5450 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5452 | (name1,nr1) :: (name2,nr2) :: _ ->
5453 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5461 (* Ignore functions that have no tests. We generate a
5462 * warning when the user does 'make check' instead.
5464 | name, _, _, _, [], _, _ -> ()
5465 | name, _, _, _, tests, _, _ ->
5469 match seq_of_test test with
5471 failwithf "%s has a test containing an empty sequence" name
5472 | cmds -> List.map List.hd cmds
5474 let funcs = List.flatten funcs in
5476 let tested = List.mem name funcs in
5479 failwithf "function %s has tests but does not test itself" name
5482 (* 'pr' prints to the current output file. *)
5483 let chan = ref Pervasives.stdout
5488 let i = count_chars '\n' str in
5489 lines := !lines + i;
5490 output_string !chan str
5493 let copyright_years =
5494 let this_year = 1900 + (localtime (time ())).tm_year in
5495 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5497 (* Generate a header block in a number of standard styles. *)
5498 type comment_style =
5499 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5500 type license = GPLv2plus | LGPLv2plus
5502 let generate_header ?(extra_inputs = []) comment license =
5503 let inputs = "src/generator.ml" :: extra_inputs in
5504 let c = match comment with
5505 | CStyle -> pr "/* "; " *"
5506 | CPlusPlusStyle -> pr "// "; "//"
5507 | HashStyle -> pr "# "; "#"
5508 | OCamlStyle -> pr "(* "; " *"
5509 | HaskellStyle -> pr "{- "; " " in
5510 pr "libguestfs generated file\n";
5511 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5512 List.iter (pr "%s %s\n" c) inputs;
5513 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5515 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5519 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5520 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5521 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5522 pr "%s (at your option) any later version.\n" c;
5524 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5525 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5526 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5527 pr "%s GNU General Public License for more details.\n" c;
5529 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5530 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5531 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5534 pr "%s This library is free software; you can redistribute it and/or\n" c;
5535 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5536 pr "%s License as published by the Free Software Foundation; either\n" c;
5537 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5539 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5540 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5541 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5542 pr "%s Lesser General Public License for more details.\n" c;
5544 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5545 pr "%s License along with this library; if not, write to the Free Software\n" c;
5546 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5549 | CStyle -> pr " */\n"
5552 | OCamlStyle -> pr " *)\n"
5553 | HaskellStyle -> pr "-}\n"
5557 (* Start of main code generation functions below this line. *)
5559 (* Generate the pod documentation for the C API. *)
5560 let rec generate_actions_pod () =
5562 fun (shortname, style, _, flags, _, _, longdesc) ->
5563 if not (List.mem NotInDocs flags) then (
5564 let name = "guestfs_" ^ shortname in
5565 pr "=head2 %s\n\n" name;
5567 generate_prototype ~extern:false ~handle:"g" name style;
5569 pr "%s\n\n" longdesc;
5570 (match fst style with
5572 pr "This function returns 0 on success or -1 on error.\n\n"
5574 pr "On error this function returns -1.\n\n"
5576 pr "On error this function returns -1.\n\n"
5578 pr "This function returns a C truth value on success or -1 on error.\n\n"
5580 pr "This function returns a string, or NULL on error.
5581 The string is owned by the guest handle and must I<not> be freed.\n\n"
5582 | RConstOptString _ ->
5583 pr "This function returns a string which may be NULL.
5584 There is way to return an error from this function.
5585 The string is owned by the guest handle and must I<not> be freed.\n\n"
5587 pr "This function returns a string, or NULL on error.
5588 I<The caller must free the returned string after use>.\n\n"
5590 pr "This function returns a NULL-terminated array of strings
5591 (like L<environ(3)>), or NULL if there was an error.
5592 I<The caller must free the strings and the array after use>.\n\n"
5593 | RStruct (_, typ) ->
5594 pr "This function returns a C<struct guestfs_%s *>,
5595 or NULL if there was an error.
5596 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5597 | RStructList (_, typ) ->
5598 pr "This function returns a C<struct guestfs_%s_list *>
5599 (see E<lt>guestfs-structs.hE<gt>),
5600 or NULL if there was an error.
5601 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5603 pr "This function returns a NULL-terminated array of
5604 strings, or NULL if there was an error.
5605 The array of strings will always have length C<2n+1>, where
5606 C<n> keys and values alternate, followed by the trailing NULL entry.
5607 I<The caller must free the strings and the array after use>.\n\n"
5609 pr "This function returns a buffer, or NULL on error.
5610 The size of the returned buffer is written to C<*size_r>.
5611 I<The caller must free the returned buffer after use>.\n\n"
5613 if List.mem ProtocolLimitWarning flags then
5614 pr "%s\n\n" protocol_limit_warning;
5615 if List.mem DangerWillRobinson flags then
5616 pr "%s\n\n" danger_will_robinson;
5617 match deprecation_notice flags with
5619 | Some txt -> pr "%s\n\n" txt
5621 ) all_functions_sorted
5623 and generate_structs_pod () =
5624 (* Structs documentation. *)
5627 pr "=head2 guestfs_%s\n" typ;
5629 pr " struct guestfs_%s {\n" typ;
5632 | name, FChar -> pr " char %s;\n" name
5633 | name, FUInt32 -> pr " uint32_t %s;\n" name
5634 | name, FInt32 -> pr " int32_t %s;\n" name
5635 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5636 | name, FInt64 -> pr " int64_t %s;\n" name
5637 | name, FString -> pr " char *%s;\n" name
5639 pr " /* The next two fields describe a byte array. */\n";
5640 pr " uint32_t %s_len;\n" name;
5641 pr " char *%s;\n" name
5643 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5644 pr " char %s[32];\n" name
5645 | name, FOptPercent ->
5646 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5647 pr " float %s;\n" name
5651 pr " struct guestfs_%s_list {\n" typ;
5652 pr " uint32_t len; /* Number of elements in list. */\n";
5653 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5656 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5657 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5662 and generate_availability_pod () =
5663 (* Availability documentation. *)
5667 fun (group, functions) ->
5668 pr "=item B<%s>\n" group;
5670 pr "The following functions:\n";
5671 List.iter (pr "L</guestfs_%s>\n") functions;
5677 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5678 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5680 * We have to use an underscore instead of a dash because otherwise
5681 * rpcgen generates incorrect code.
5683 * This header is NOT exported to clients, but see also generate_structs_h.
5685 and generate_xdr () =
5686 generate_header CStyle LGPLv2plus;
5688 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5689 pr "typedef string str<>;\n";
5692 (* Internal structures. *)
5696 pr "struct guestfs_int_%s {\n" typ;
5698 | name, FChar -> pr " char %s;\n" name
5699 | name, FString -> pr " string %s<>;\n" name
5700 | name, FBuffer -> pr " opaque %s<>;\n" name
5701 | name, FUUID -> pr " opaque %s[32];\n" name
5702 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5703 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5704 | name, FOptPercent -> pr " float %s;\n" name
5708 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5713 fun (shortname, style, _, _, _, _, _) ->
5714 let name = "guestfs_" ^ shortname in
5716 (match snd style with
5719 pr "struct %s_args {\n" name;
5722 | Pathname n | Device n | Dev_or_Path n | String n ->
5723 pr " string %s<>;\n" n
5724 | OptString n -> pr " str *%s;\n" n
5725 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5726 | Bool n -> pr " bool %s;\n" n
5727 | Int n -> pr " int %s;\n" n
5728 | Int64 n -> pr " hyper %s;\n" n
5730 pr " opaque %s<>;\n" n
5731 | FileIn _ | FileOut _ -> ()
5735 (match fst style with
5738 pr "struct %s_ret {\n" name;
5742 pr "struct %s_ret {\n" name;
5743 pr " hyper %s;\n" n;
5746 pr "struct %s_ret {\n" name;
5749 | RConstString _ | RConstOptString _ ->
5750 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5752 pr "struct %s_ret {\n" name;
5753 pr " string %s<>;\n" n;
5756 pr "struct %s_ret {\n" name;
5757 pr " str %s<>;\n" n;
5759 | RStruct (n, typ) ->
5760 pr "struct %s_ret {\n" name;
5761 pr " guestfs_int_%s %s;\n" typ n;
5763 | RStructList (n, typ) ->
5764 pr "struct %s_ret {\n" name;
5765 pr " guestfs_int_%s_list %s;\n" typ n;
5768 pr "struct %s_ret {\n" name;
5769 pr " str %s<>;\n" n;
5772 pr "struct %s_ret {\n" name;
5773 pr " opaque %s<>;\n" n;
5778 (* Table of procedure numbers. *)
5779 pr "enum guestfs_procedure {\n";
5781 fun (shortname, _, proc_nr, _, _, _, _) ->
5782 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5784 pr " GUESTFS_PROC_NR_PROCS\n";
5788 (* Having to choose a maximum message size is annoying for several
5789 * reasons (it limits what we can do in the API), but it (a) makes
5790 * the protocol a lot simpler, and (b) provides a bound on the size
5791 * of the daemon which operates in limited memory space.
5793 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5796 (* Message header, etc. *)
5798 /* The communication protocol is now documented in the guestfs(3)
5802 const GUESTFS_PROGRAM = 0x2000F5F5;
5803 const GUESTFS_PROTOCOL_VERSION = 1;
5805 /* These constants must be larger than any possible message length. */
5806 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5807 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5809 enum guestfs_message_direction {
5810 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5811 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5814 enum guestfs_message_status {
5815 GUESTFS_STATUS_OK = 0,
5816 GUESTFS_STATUS_ERROR = 1
5819 const GUESTFS_ERROR_LEN = 256;
5821 struct guestfs_message_error {
5822 string error_message<GUESTFS_ERROR_LEN>;
5825 struct guestfs_message_header {
5826 unsigned prog; /* GUESTFS_PROGRAM */
5827 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5828 guestfs_procedure proc; /* GUESTFS_PROC_x */
5829 guestfs_message_direction direction;
5830 unsigned serial; /* message serial number */
5831 guestfs_message_status status;
5834 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5836 struct guestfs_chunk {
5837 int cancel; /* if non-zero, transfer is cancelled */
5838 /* data size is 0 bytes if the transfer has finished successfully */
5839 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5843 (* Generate the guestfs-structs.h file. *)
5844 and generate_structs_h () =
5845 generate_header CStyle LGPLv2plus;
5847 (* This is a public exported header file containing various
5848 * structures. The structures are carefully written to have
5849 * exactly the same in-memory format as the XDR structures that
5850 * we use on the wire to the daemon. The reason for creating
5851 * copies of these structures here is just so we don't have to
5852 * export the whole of guestfs_protocol.h (which includes much
5853 * unrelated and XDR-dependent stuff that we don't want to be
5854 * public, or required by clients).
5856 * To reiterate, we will pass these structures to and from the
5857 * client with a simple assignment or memcpy, so the format
5858 * must be identical to what rpcgen / the RFC defines.
5861 (* Public structures. *)
5864 pr "struct guestfs_%s {\n" typ;
5867 | name, FChar -> pr " char %s;\n" name
5868 | name, FString -> pr " char *%s;\n" name
5870 pr " uint32_t %s_len;\n" name;
5871 pr " char *%s;\n" name
5872 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5873 | name, FUInt32 -> pr " uint32_t %s;\n" name
5874 | name, FInt32 -> pr " int32_t %s;\n" name
5875 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5876 | name, FInt64 -> pr " int64_t %s;\n" name
5877 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5881 pr "struct guestfs_%s_list {\n" typ;
5882 pr " uint32_t len;\n";
5883 pr " struct guestfs_%s *val;\n" typ;
5886 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5887 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5891 (* Generate the guestfs-actions.h file. *)
5892 and generate_actions_h () =
5893 generate_header CStyle LGPLv2plus;
5895 fun (shortname, style, _, _, _, _, _) ->
5896 let name = "guestfs_" ^ shortname in
5897 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5901 (* Generate the guestfs-internal-actions.h file. *)
5902 and generate_internal_actions_h () =
5903 generate_header CStyle LGPLv2plus;
5905 fun (shortname, style, _, _, _, _, _) ->
5906 let name = "guestfs__" ^ shortname in
5907 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5909 ) non_daemon_functions
5911 (* Generate the client-side dispatch stubs. *)
5912 and generate_client_actions () =
5913 generate_header CStyle LGPLv2plus;
5920 #include <inttypes.h>
5922 #include \"guestfs.h\"
5923 #include \"guestfs-internal.h\"
5924 #include \"guestfs-internal-actions.h\"
5925 #include \"guestfs_protocol.h\"
5927 #define error guestfs_error
5928 //#define perrorf guestfs_perrorf
5929 #define safe_malloc guestfs_safe_malloc
5930 #define safe_realloc guestfs_safe_realloc
5931 //#define safe_strdup guestfs_safe_strdup
5932 #define safe_memdup guestfs_safe_memdup
5934 /* Check the return message from a call for validity. */
5936 check_reply_header (guestfs_h *g,
5937 const struct guestfs_message_header *hdr,
5938 unsigned int proc_nr, unsigned int serial)
5940 if (hdr->prog != GUESTFS_PROGRAM) {
5941 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5944 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5945 error (g, \"wrong protocol version (%%d/%%d)\",
5946 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5949 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5950 error (g, \"unexpected message direction (%%d/%%d)\",
5951 hdr->direction, GUESTFS_DIRECTION_REPLY);
5954 if (hdr->proc != proc_nr) {
5955 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5958 if (hdr->serial != serial) {
5959 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5966 /* Check we are in the right state to run a high-level action. */
5968 check_state (guestfs_h *g, const char *caller)
5970 if (!guestfs__is_ready (g)) {
5971 if (guestfs__is_config (g) || guestfs__is_launching (g))
5972 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5975 error (g, \"%%s called from the wrong state, %%d != READY\",
5976 caller, guestfs__get_state (g));
5984 let error_code_of = function
5985 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5986 | RConstString _ | RConstOptString _
5987 | RString _ | RStringList _
5988 | RStruct _ | RStructList _
5989 | RHashtable _ | RBufferOut _ -> "NULL"
5992 (* Generate code to check String-like parameters are not passed in
5993 * as NULL (returning an error if they are).
5995 let check_null_strings shortname style =
5996 let pr_newline = ref false in
5999 (* parameters which should not be NULL *)
6009 pr " if (%s == NULL) {\n" n;
6010 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
6011 pr " \"%s\", \"%s\");\n" shortname n;
6012 pr " return %s;\n" (error_code_of (fst style));
6019 (* not applicable *)
6025 if !pr_newline then pr "\n";
6028 (* Generate code to generate guestfish call traces. *)
6029 let trace_call shortname style =
6030 pr " if (guestfs__get_trace (g)) {\n";
6033 List.exists (function
6034 | StringList _ | DeviceList _ -> true
6035 | _ -> false) (snd style) in
6041 pr " printf (\"%s\");\n" shortname;
6044 | String n (* strings *)
6051 (* guestfish doesn't support string escaping, so neither do we *)
6052 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
6053 | OptString n -> (* string option *)
6054 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
6055 pr " else printf (\" null\");\n"
6057 | DeviceList n -> (* string list *)
6058 pr " putchar (' ');\n";
6059 pr " putchar ('\"');\n";
6060 pr " for (i = 0; %s[i]; ++i) {\n" n;
6061 pr " if (i > 0) putchar (' ');\n";
6062 pr " fputs (%s[i], stdout);\n" n;
6064 pr " putchar ('\"');\n";
6065 | Bool n -> (* boolean *)
6066 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
6067 | Int n -> (* int *)
6068 pr " printf (\" %%d\", %s);\n" n
6070 pr " printf (\" %%\" PRIi64, %s);\n" n
6072 pr " putchar ('\\n');\n";
6077 (* For non-daemon functions, generate a wrapper around each function. *)
6079 fun (shortname, style, _, _, _, _, _) ->
6080 let name = "guestfs_" ^ shortname in
6082 generate_prototype ~extern:false ~semicolon:false ~newline:true
6083 ~handle:"g" name style;
6085 check_null_strings shortname style;
6086 trace_call shortname style;
6087 pr " return guestfs__%s " shortname;
6088 generate_c_call_args ~handle:"g" style;
6092 ) non_daemon_functions;
6094 (* Client-side stubs for each function. *)
6096 fun (shortname, style, _, _, _, _, _) ->
6097 let name = "guestfs_" ^ shortname in
6098 let error_code = error_code_of (fst style) in
6100 (* Generate the action stub. *)
6101 generate_prototype ~extern:false ~semicolon:false ~newline:true
6102 ~handle:"g" name style;
6106 (match snd style with
6108 | _ -> pr " struct %s_args args;\n" name
6111 pr " guestfs_message_header hdr;\n";
6112 pr " guestfs_message_error err;\n";
6114 match fst style with
6116 | RConstString _ | RConstOptString _ ->
6117 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6119 | RBool _ | RString _ | RStringList _
6120 | RStruct _ | RStructList _
6121 | RHashtable _ | RBufferOut _ ->
6122 pr " struct %s_ret ret;\n" name;
6125 pr " int serial;\n";
6128 check_null_strings shortname style;
6129 trace_call shortname style;
6130 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
6131 shortname error_code;
6132 pr " guestfs___set_busy (g);\n";
6135 (* Send the main header and arguments. *)
6136 (match snd style with
6138 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6139 (String.uppercase shortname)
6143 | Pathname n | Device n | Dev_or_Path n | String n ->
6144 pr " args.%s = (char *) %s;\n" n n
6146 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6147 | StringList n | DeviceList n ->
6148 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6149 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6151 pr " args.%s = %s;\n" n n
6153 pr " args.%s = %s;\n" n n
6155 pr " args.%s = %s;\n" n n
6156 | FileIn _ | FileOut _ -> ()
6158 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6159 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6160 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6162 pr " guestfs___end_busy (g);\n";
6163 pr " return %s;\n" error_code;
6165 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6166 pr " args.%s.%s_len = %s_size;\n" n n n
6168 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6169 (String.uppercase shortname);
6170 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6173 pr " if (serial == -1) {\n";
6174 pr " guestfs___end_busy (g);\n";
6175 pr " return %s;\n" error_code;
6179 (* Send any additional files (FileIn) requested. *)
6180 let need_read_reply_label = ref false in
6184 pr " r = guestfs___send_file (g, %s);\n" n;
6185 pr " if (r == -1) {\n";
6186 pr " guestfs___end_busy (g);\n";
6187 pr " return %s;\n" error_code;
6189 pr " if (r == -2) /* daemon cancelled */\n";
6190 pr " goto read_reply;\n";
6191 need_read_reply_label := true;
6196 (* Wait for the reply from the remote end. *)
6197 if !need_read_reply_label then pr " read_reply:\n";
6198 pr " memset (&hdr, 0, sizeof hdr);\n";
6199 pr " memset (&err, 0, sizeof err);\n";
6200 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6202 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6206 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6209 pr " if (r == -1) {\n";
6210 pr " guestfs___end_busy (g);\n";
6211 pr " return %s;\n" error_code;
6215 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6216 (String.uppercase shortname);
6217 pr " guestfs___end_busy (g);\n";
6218 pr " return %s;\n" error_code;
6222 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6223 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6224 pr " free (err.error_message);\n";
6225 pr " guestfs___end_busy (g);\n";
6226 pr " return %s;\n" error_code;
6230 (* Expecting to receive further files (FileOut)? *)
6234 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6235 pr " guestfs___end_busy (g);\n";
6236 pr " return %s;\n" error_code;
6242 pr " guestfs___end_busy (g);\n";
6244 (match fst style with
6245 | RErr -> pr " return 0;\n"
6246 | RInt n | RInt64 n | RBool n ->
6247 pr " return ret.%s;\n" n
6248 | RConstString _ | RConstOptString _ ->
6249 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6251 pr " return ret.%s; /* caller will free */\n" n
6252 | RStringList n | RHashtable n ->
6253 pr " /* caller will free this, but we need to add a NULL entry */\n";
6254 pr " ret.%s.%s_val =\n" n n;
6255 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6256 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6258 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6259 pr " return ret.%s.%s_val;\n" n n
6261 pr " /* caller will free this */\n";
6262 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6263 | RStructList (n, _) ->
6264 pr " /* caller will free this */\n";
6265 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6267 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6268 pr " * _val might be NULL here. To make the API saner for\n";
6269 pr " * callers, we turn this case into a unique pointer (using\n";
6270 pr " * malloc(1)).\n";
6272 pr " if (ret.%s.%s_len > 0) {\n" n n;
6273 pr " *size_r = ret.%s.%s_len;\n" n n;
6274 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6276 pr " free (ret.%s.%s_val);\n" n n;
6277 pr " char *p = safe_malloc (g, 1);\n";
6278 pr " *size_r = ret.%s.%s_len;\n" n n;
6286 (* Functions to free structures. *)
6287 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6288 pr " * structure format is identical to the XDR format. See note in\n";
6289 pr " * generator.ml.\n";
6296 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6298 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6304 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6306 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6313 (* Generate daemon/actions.h. *)
6314 and generate_daemon_actions_h () =
6315 generate_header CStyle GPLv2plus;
6317 pr "#include \"../src/guestfs_protocol.h\"\n";
6321 fun (name, style, _, _, _, _, _) ->
6323 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6327 (* Generate the linker script which controls the visibility of
6328 * symbols in the public ABI and ensures no other symbols get
6329 * exported accidentally.
6331 and generate_linker_script () =
6332 generate_header HashStyle GPLv2plus;
6337 "guestfs_get_error_handler";
6338 "guestfs_get_out_of_memory_handler";
6339 "guestfs_last_error";
6340 "guestfs_set_error_handler";
6341 "guestfs_set_launch_done_callback";
6342 "guestfs_set_log_message_callback";
6343 "guestfs_set_out_of_memory_handler";
6344 "guestfs_set_subprocess_quit_callback";
6346 (* Unofficial parts of the API: the bindings code use these
6347 * functions, so it is useful to export them.
6349 "guestfs_safe_calloc";
6350 "guestfs_safe_malloc";
6353 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6357 List.map (fun (typ, _) ->
6358 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6361 let globals = List.sort compare (globals @ functions @ structs) in
6365 List.iter (pr " %s;\n") globals;
6372 (* Generate the server-side stubs. *)
6373 and generate_daemon_actions () =
6374 generate_header CStyle GPLv2plus;
6376 pr "#include <config.h>\n";
6378 pr "#include <stdio.h>\n";
6379 pr "#include <stdlib.h>\n";
6380 pr "#include <string.h>\n";
6381 pr "#include <inttypes.h>\n";
6382 pr "#include <rpc/types.h>\n";
6383 pr "#include <rpc/xdr.h>\n";
6385 pr "#include \"daemon.h\"\n";
6386 pr "#include \"c-ctype.h\"\n";
6387 pr "#include \"../src/guestfs_protocol.h\"\n";
6388 pr "#include \"actions.h\"\n";
6392 fun (name, style, _, _, _, _, _) ->
6393 (* Generate server-side stubs. *)
6394 pr "static void %s_stub (XDR *xdr_in)\n" name;
6397 match fst style with
6398 | RErr | RInt _ -> pr " int r;\n"; "-1"
6399 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6400 | RBool _ -> pr " int r;\n"; "-1"
6401 | RConstString _ | RConstOptString _ ->
6402 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6403 | RString _ -> pr " char *r;\n"; "NULL"
6404 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6405 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6406 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6408 pr " size_t size = 1;\n";
6412 (match snd style with
6415 pr " struct guestfs_%s_args args;\n" name;
6418 | Device n | Dev_or_Path n
6421 | OptString n -> pr " char *%s;\n" n
6422 | StringList n | DeviceList n -> pr " char **%s;\n" n
6423 | Bool n -> pr " int %s;\n" n
6424 | Int n -> pr " int %s;\n" n
6425 | Int64 n -> pr " int64_t %s;\n" n
6426 | FileIn _ | FileOut _ -> ()
6428 pr " const char *%s;\n" n;
6429 pr " size_t %s_size;\n" n
6435 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6437 (match snd style with
6440 pr " memset (&args, 0, sizeof args);\n";
6442 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6444 pr " if (cancel_receive () != -2)\n";
6445 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6449 pr " char *%s = args.%s;\n" n n
6451 let pr_list_handling_code n =
6452 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6453 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6454 pr " if (%s == NULL) {\n" n;
6456 pr " if (cancel_receive () != -2)\n";
6457 pr " reply_with_perror (\"realloc\");\n";
6460 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6461 pr " args.%s.%s_val = %s;\n" n n n;
6467 pr " ABS_PATH (%s, %s, goto done);\n"
6468 n (if is_filein then "cancel_receive ()" else "0");
6471 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6472 n (if is_filein then "cancel_receive ()" else "0");
6475 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6476 n (if is_filein then "cancel_receive ()" else "0");
6477 | String n -> pr_args n
6478 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6480 pr_list_handling_code n;
6482 pr_list_handling_code n;
6483 pr " /* Ensure that each is a device,\n";
6484 pr " * and perform device name translation. */\n";
6485 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6486 pr " RESOLVE_DEVICE (physvols[pvi], %s, goto done);\n"
6487 (if is_filein then "cancel_receive ()" else "0");
6489 | Bool n -> pr " %s = args.%s;\n" n n
6490 | Int n -> pr " %s = args.%s;\n" n n
6491 | Int64 n -> pr " %s = args.%s;\n" n n
6492 | FileIn _ | FileOut _ -> ()
6494 pr " %s = args.%s.%s_val;\n" n n n;
6495 pr " %s_size = args.%s.%s_len;\n" n n n
6500 (* this is used at least for do_equal *)
6501 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6502 (* Emit NEED_ROOT just once, even when there are two or
6503 more Pathname args *)
6504 pr " NEED_ROOT (%s, goto done);\n"
6505 (if is_filein then "cancel_receive ()" else "0");
6508 (* Don't want to call the impl with any FileIn or FileOut
6509 * parameters, since these go "outside" the RPC protocol.
6512 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6514 pr " r = do_%s " name;
6515 generate_c_call_args (fst style, args');
6518 (match fst style with
6519 | RErr | RInt _ | RInt64 _ | RBool _
6520 | RConstString _ | RConstOptString _
6521 | RString _ | RStringList _ | RHashtable _
6522 | RStruct (_, _) | RStructList (_, _) ->
6523 pr " if (r == %s)\n" error_code;
6524 pr " /* do_%s has already called reply_with_error */\n" name;
6528 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6529 pr " * an ordinary zero-length buffer), so be careful ...\n";
6531 pr " if (size == 1 && r == %s)\n" error_code;
6532 pr " /* do_%s has already called reply_with_error */\n" name;
6537 (* If there are any FileOut parameters, then the impl must
6538 * send its own reply.
6541 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6543 pr " /* do_%s has already sent a reply */\n" name
6545 match fst style with
6546 | RErr -> pr " reply (NULL, NULL);\n"
6547 | RInt n | RInt64 n | RBool n ->
6548 pr " struct guestfs_%s_ret ret;\n" name;
6549 pr " ret.%s = r;\n" n;
6550 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6552 | RConstString _ | RConstOptString _ ->
6553 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6555 pr " struct guestfs_%s_ret ret;\n" name;
6556 pr " ret.%s = r;\n" n;
6557 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6560 | RStringList n | RHashtable n ->
6561 pr " struct guestfs_%s_ret ret;\n" name;
6562 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6563 pr " ret.%s.%s_val = r;\n" n n;
6564 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6566 pr " free_strings (r);\n"
6568 pr " struct guestfs_%s_ret ret;\n" name;
6569 pr " ret.%s = *r;\n" n;
6570 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6572 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6574 | RStructList (n, _) ->
6575 pr " struct guestfs_%s_ret ret;\n" name;
6576 pr " ret.%s = *r;\n" n;
6577 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6579 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6582 pr " struct guestfs_%s_ret ret;\n" name;
6583 pr " ret.%s.%s_val = r;\n" n n;
6584 pr " ret.%s.%s_len = size;\n" n n;
6585 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6590 (* Free the args. *)
6592 (match snd style with
6595 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6602 (* Dispatch function. *)
6603 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6605 pr " switch (proc_nr) {\n";
6608 fun (name, style, _, _, _, _, _) ->
6609 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6610 pr " %s_stub (xdr_in);\n" name;
6615 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";
6620 (* LVM columns and tokenization functions. *)
6621 (* XXX This generates crap code. We should rethink how we
6627 pr "static const char *lvm_%s_cols = \"%s\";\n"
6628 typ (String.concat "," (List.map fst cols));
6631 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6633 pr " char *tok, *p, *next;\n";
6637 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6640 pr " if (!str) {\n";
6641 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6644 pr " if (!*str || c_isspace (*str)) {\n";
6645 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6650 fun (name, coltype) ->
6651 pr " if (!tok) {\n";
6652 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6655 pr " p = strchrnul (tok, ',');\n";
6656 pr " if (*p) next = p+1; else next = NULL;\n";
6657 pr " *p = '\\0';\n";
6660 pr " r->%s = strdup (tok);\n" name;
6661 pr " if (r->%s == NULL) {\n" name;
6662 pr " perror (\"strdup\");\n";
6666 pr " for (i = j = 0; i < 32; ++j) {\n";
6667 pr " if (tok[j] == '\\0') {\n";
6668 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6670 pr " } else if (tok[j] != '-')\n";
6671 pr " r->%s[i++] = tok[j];\n" name;
6674 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6675 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6679 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6680 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6684 pr " if (tok[0] == '\\0')\n";
6685 pr " r->%s = -1;\n" name;
6686 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6687 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6690 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6691 assert false (* can never be an LVM column *)
6693 pr " tok = next;\n";
6696 pr " if (tok != NULL) {\n";
6697 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6704 pr "guestfs_int_lvm_%s_list *\n" typ;
6705 pr "parse_command_line_%ss (void)\n" typ;
6707 pr " char *out, *err;\n";
6708 pr " char *p, *pend;\n";
6710 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6711 pr " void *newp;\n";
6713 pr " ret = malloc (sizeof *ret);\n";
6714 pr " if (!ret) {\n";
6715 pr " reply_with_perror (\"malloc\");\n";
6716 pr " return NULL;\n";
6719 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6720 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6722 pr " r = command (&out, &err,\n";
6723 pr " \"lvm\", \"%ss\",\n" typ;
6724 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6725 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6726 pr " if (r == -1) {\n";
6727 pr " reply_with_error (\"%%s\", err);\n";
6728 pr " free (out);\n";
6729 pr " free (err);\n";
6730 pr " free (ret);\n";
6731 pr " return NULL;\n";
6734 pr " free (err);\n";
6736 pr " /* Tokenize each line of the output. */\n";
6739 pr " while (p) {\n";
6740 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6741 pr " if (pend) {\n";
6742 pr " *pend = '\\0';\n";
6746 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6749 pr " if (!*p) { /* Empty line? Skip it. */\n";
6754 pr " /* Allocate some space to store this next entry. */\n";
6755 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6756 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6757 pr " if (newp == NULL) {\n";
6758 pr " reply_with_perror (\"realloc\");\n";
6759 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6760 pr " free (ret);\n";
6761 pr " free (out);\n";
6762 pr " return NULL;\n";
6764 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6766 pr " /* Tokenize the next entry. */\n";
6767 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6768 pr " if (r == -1) {\n";
6769 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6770 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6771 pr " free (ret);\n";
6772 pr " free (out);\n";
6773 pr " return NULL;\n";
6780 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6782 pr " free (out);\n";
6783 pr " return ret;\n";
6786 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6788 (* Generate a list of function names, for debugging in the daemon.. *)
6789 and generate_daemon_names () =
6790 generate_header CStyle GPLv2plus;
6792 pr "#include <config.h>\n";
6794 pr "#include \"daemon.h\"\n";
6797 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6798 pr "const char *function_names[] = {\n";
6800 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6804 (* Generate the optional groups for the daemon to implement
6805 * guestfs_available.
6807 and generate_daemon_optgroups_c () =
6808 generate_header CStyle GPLv2plus;
6810 pr "#include <config.h>\n";
6812 pr "#include \"daemon.h\"\n";
6813 pr "#include \"optgroups.h\"\n";
6816 pr "struct optgroup optgroups[] = {\n";
6819 pr " { \"%s\", optgroup_%s_available },\n" group group
6821 pr " { NULL, NULL }\n";
6824 and generate_daemon_optgroups_h () =
6825 generate_header CStyle GPLv2plus;
6829 pr "extern int optgroup_%s_available (void);\n" group
6832 (* Generate the tests. *)
6833 and generate_tests () =
6834 generate_header CStyle GPLv2plus;
6841 #include <sys/types.h>
6844 #include \"guestfs.h\"
6845 #include \"guestfs-internal.h\"
6847 static guestfs_h *g;
6848 static int suppress_error = 0;
6850 static void print_error (guestfs_h *g, void *data, const char *msg)
6852 if (!suppress_error)
6853 fprintf (stderr, \"%%s\\n\", msg);
6856 /* FIXME: nearly identical code appears in fish.c */
6857 static void print_strings (char *const *argv)
6861 for (argc = 0; argv[argc] != NULL; ++argc)
6862 printf (\"\\t%%s\\n\", argv[argc]);
6866 static void print_table (char const *const *argv)
6870 for (i = 0; argv[i] != NULL; i += 2)
6871 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6876 is_available (const char *group)
6878 const char *groups[] = { group, NULL };
6882 r = guestfs_available (g, (char **) groups);
6890 (* Generate a list of commands which are not tested anywhere. *)
6891 pr "static void no_test_warnings (void)\n";
6894 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6896 fun (_, _, _, _, tests, _, _) ->
6897 let tests = filter_map (
6899 | (_, (Always|If _|Unless _|IfAvailable _), test) -> Some test
6900 | (_, Disabled, _) -> None
6902 let seq = List.concat (List.map seq_of_test tests) in
6903 let cmds_tested = List.map List.hd seq in
6904 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6908 fun (name, _, _, _, _, _, _) ->
6909 if not (Hashtbl.mem hash name) then
6910 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6916 (* Generate the actual tests. Note that we generate the tests
6917 * in reverse order, deliberately, so that (in general) the
6918 * newest tests run first. This makes it quicker and easier to
6923 fun (name, _, _, flags, tests, _, _) ->
6924 mapi (generate_one_test name flags) tests
6925 ) (List.rev all_functions) in
6926 let test_names = List.concat test_names in
6927 let nr_tests = List.length test_names in
6930 int main (int argc, char *argv[])
6933 unsigned long int n_failed = 0;
6934 const char *filename;
6936 int nr_tests, test_num = 0;
6938 setbuf (stdout, NULL);
6940 no_test_warnings ();
6942 g = guestfs_create ();
6944 printf (\"guestfs_create FAILED\\n\");
6945 exit (EXIT_FAILURE);
6948 guestfs_set_error_handler (g, print_error, NULL);
6950 guestfs_set_path (g, \"../appliance\");
6952 filename = \"test1.img\";
6953 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6956 exit (EXIT_FAILURE);
6958 if (lseek (fd, %d, SEEK_SET) == -1) {
6962 exit (EXIT_FAILURE);
6964 if (write (fd, &c, 1) == -1) {
6968 exit (EXIT_FAILURE);
6970 if (close (fd) == -1) {
6973 exit (EXIT_FAILURE);
6975 if (guestfs_add_drive (g, filename) == -1) {
6976 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6977 exit (EXIT_FAILURE);
6980 filename = \"test2.img\";
6981 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6984 exit (EXIT_FAILURE);
6986 if (lseek (fd, %d, SEEK_SET) == -1) {
6990 exit (EXIT_FAILURE);
6992 if (write (fd, &c, 1) == -1) {
6996 exit (EXIT_FAILURE);
6998 if (close (fd) == -1) {
7001 exit (EXIT_FAILURE);
7003 if (guestfs_add_drive (g, filename) == -1) {
7004 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7005 exit (EXIT_FAILURE);
7008 filename = \"test3.img\";
7009 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7012 exit (EXIT_FAILURE);
7014 if (lseek (fd, %d, SEEK_SET) == -1) {
7018 exit (EXIT_FAILURE);
7020 if (write (fd, &c, 1) == -1) {
7024 exit (EXIT_FAILURE);
7026 if (close (fd) == -1) {
7029 exit (EXIT_FAILURE);
7031 if (guestfs_add_drive (g, filename) == -1) {
7032 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7033 exit (EXIT_FAILURE);
7036 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
7037 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
7038 exit (EXIT_FAILURE);
7041 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
7044 if (guestfs_launch (g) == -1) {
7045 printf (\"guestfs_launch FAILED\\n\");
7046 exit (EXIT_FAILURE);
7049 /* Cancel previous alarm. */
7054 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
7058 pr " test_num++;\n";
7059 pr " if (guestfs_get_verbose (g))\n";
7060 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
7061 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
7062 pr " if (%s () == -1) {\n" test_name;
7063 pr " printf (\"%s FAILED\\n\");\n" test_name;
7064 pr " n_failed++;\n";
7069 pr " guestfs_close (g);\n";
7070 pr " unlink (\"test1.img\");\n";
7071 pr " unlink (\"test2.img\");\n";
7072 pr " unlink (\"test3.img\");\n";
7075 pr " if (n_failed > 0) {\n";
7076 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
7077 pr " exit (EXIT_FAILURE);\n";
7081 pr " exit (EXIT_SUCCESS);\n";
7084 and generate_one_test name flags i (init, prereq, test) =
7085 let test_name = sprintf "test_%s_%d" name i in
7088 static int %s_skip (void)
7092 str = getenv (\"TEST_ONLY\");
7094 return strstr (str, \"%s\") == NULL;
7095 str = getenv (\"SKIP_%s\");
7096 if (str && STREQ (str, \"1\")) return 1;
7097 str = getenv (\"SKIP_TEST_%s\");
7098 if (str && STREQ (str, \"1\")) return 1;
7102 " test_name name (String.uppercase test_name) (String.uppercase name);
7105 | Disabled | Always | IfAvailable _ -> ()
7106 | If code | Unless code ->
7107 pr "static int %s_prereq (void)\n" test_name;
7115 static int %s (void)
7118 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
7122 " test_name test_name test_name;
7124 (* Optional functions should only be tested if the relevant
7125 * support is available in the daemon.
7130 pr " if (!is_available (\"%s\")) {\n" group;
7131 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", \"%s\");\n" test_name group;
7139 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7141 pr " if (! %s_prereq ()) {\n" test_name;
7142 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7146 generate_one_test_body name i test_name init test;
7148 pr " if (%s_prereq ()) {\n" test_name;
7149 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7153 generate_one_test_body name i test_name init test;
7154 | IfAvailable group ->
7155 pr " if (!is_available (\"%s\")) {\n" group;
7156 pr " printf (\" %%s skipped (reason: %%s not available)\\n\", \"%s\", \"%s\");\n" test_name group;
7160 generate_one_test_body name i test_name init test;
7162 generate_one_test_body name i test_name init test
7170 and generate_one_test_body name i test_name init test =
7172 | InitNone (* XXX at some point, InitNone and InitEmpty became
7173 * folded together as the same thing. Really we should
7174 * make InitNone do nothing at all, but the tests may
7175 * need to be checked to make sure this is OK.
7178 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7179 List.iter (generate_test_command_call test_name)
7180 [["blockdev_setrw"; "/dev/sda"];
7184 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7185 List.iter (generate_test_command_call test_name)
7186 [["blockdev_setrw"; "/dev/sda"];
7189 ["part_disk"; "/dev/sda"; "mbr"]]
7191 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7192 List.iter (generate_test_command_call test_name)
7193 [["blockdev_setrw"; "/dev/sda"];
7196 ["part_disk"; "/dev/sda"; "mbr"];
7197 ["mkfs"; "ext2"; "/dev/sda1"];
7198 ["mount_options"; ""; "/dev/sda1"; "/"]]
7199 | InitBasicFSonLVM ->
7200 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7202 List.iter (generate_test_command_call test_name)
7203 [["blockdev_setrw"; "/dev/sda"];
7206 ["part_disk"; "/dev/sda"; "mbr"];
7207 ["pvcreate"; "/dev/sda1"];
7208 ["vgcreate"; "VG"; "/dev/sda1"];
7209 ["lvcreate"; "LV"; "VG"; "8"];
7210 ["mkfs"; "ext2"; "/dev/VG/LV"];
7211 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7213 pr " /* InitISOFS for %s */\n" test_name;
7214 List.iter (generate_test_command_call test_name)
7215 [["blockdev_setrw"; "/dev/sda"];
7218 ["mount_ro"; "/dev/sdd"; "/"]]
7221 let get_seq_last = function
7223 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7226 let seq = List.rev seq in
7227 List.rev (List.tl seq), List.hd seq
7232 pr " /* TestRun for %s (%d) */\n" name i;
7233 List.iter (generate_test_command_call test_name) seq
7234 | TestOutput (seq, expected) ->
7235 pr " /* TestOutput for %s (%d) */\n" name i;
7236 pr " const char *expected = \"%s\";\n" (c_quote expected);
7237 let seq, last = get_seq_last seq in
7239 pr " if (STRNEQ (r, expected)) {\n";
7240 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7244 List.iter (generate_test_command_call test_name) seq;
7245 generate_test_command_call ~test test_name last
7246 | TestOutputList (seq, expected) ->
7247 pr " /* TestOutputList for %s (%d) */\n" name i;
7248 let seq, last = get_seq_last seq in
7252 pr " if (!r[%d]) {\n" i;
7253 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7254 pr " print_strings (r);\n";
7258 pr " const char *expected = \"%s\";\n" (c_quote str);
7259 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7260 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7265 pr " if (r[%d] != NULL) {\n" (List.length expected);
7266 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7268 pr " print_strings (r);\n";
7272 List.iter (generate_test_command_call test_name) seq;
7273 generate_test_command_call ~test test_name last
7274 | TestOutputListOfDevices (seq, expected) ->
7275 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7276 let seq, last = get_seq_last seq in
7280 pr " if (!r[%d]) {\n" i;
7281 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7282 pr " print_strings (r);\n";
7286 pr " const char *expected = \"%s\";\n" (c_quote str);
7287 pr " r[%d][5] = 's';\n" i;
7288 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7289 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7294 pr " if (r[%d] != NULL) {\n" (List.length expected);
7295 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7297 pr " print_strings (r);\n";
7301 List.iter (generate_test_command_call test_name) seq;
7302 generate_test_command_call ~test test_name last
7303 | TestOutputInt (seq, expected) ->
7304 pr " /* TestOutputInt for %s (%d) */\n" name i;
7305 let seq, last = get_seq_last seq in
7307 pr " if (r != %d) {\n" expected;
7308 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7314 List.iter (generate_test_command_call test_name) seq;
7315 generate_test_command_call ~test test_name last
7316 | TestOutputIntOp (seq, op, expected) ->
7317 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7318 let seq, last = get_seq_last seq in
7320 pr " if (! (r %s %d)) {\n" op expected;
7321 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7322 test_name op expected;
7327 List.iter (generate_test_command_call test_name) seq;
7328 generate_test_command_call ~test test_name last
7329 | TestOutputTrue seq ->
7330 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7331 let seq, last = get_seq_last seq in
7334 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7339 List.iter (generate_test_command_call test_name) seq;
7340 generate_test_command_call ~test test_name last
7341 | TestOutputFalse seq ->
7342 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7343 let seq, last = get_seq_last seq in
7346 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7351 List.iter (generate_test_command_call test_name) seq;
7352 generate_test_command_call ~test test_name last
7353 | TestOutputLength (seq, expected) ->
7354 pr " /* TestOutputLength for %s (%d) */\n" name i;
7355 let seq, last = get_seq_last seq in
7358 pr " for (j = 0; j < %d; ++j)\n" expected;
7359 pr " if (r[j] == NULL) {\n";
7360 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7362 pr " print_strings (r);\n";
7365 pr " if (r[j] != NULL) {\n";
7366 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7368 pr " print_strings (r);\n";
7372 List.iter (generate_test_command_call test_name) seq;
7373 generate_test_command_call ~test test_name last
7374 | TestOutputBuffer (seq, expected) ->
7375 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7376 pr " const char *expected = \"%s\";\n" (c_quote expected);
7377 let seq, last = get_seq_last seq in
7378 let len = String.length expected in
7380 pr " if (size != %d) {\n" len;
7381 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7384 pr " if (STRNEQLEN (r, expected, size)) {\n";
7385 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7389 List.iter (generate_test_command_call test_name) seq;
7390 generate_test_command_call ~test test_name last
7391 | TestOutputStruct (seq, checks) ->
7392 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7393 let seq, last = get_seq_last seq in
7397 | CompareWithInt (field, expected) ->
7398 pr " if (r->%s != %d) {\n" field expected;
7399 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7400 test_name field expected;
7401 pr " (int) r->%s);\n" field;
7404 | CompareWithIntOp (field, op, expected) ->
7405 pr " if (!(r->%s %s %d)) {\n" field op expected;
7406 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7407 test_name field op expected;
7408 pr " (int) r->%s);\n" field;
7411 | CompareWithString (field, expected) ->
7412 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7413 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7414 test_name field expected;
7415 pr " r->%s);\n" field;
7418 | CompareFieldsIntEq (field1, field2) ->
7419 pr " if (r->%s != r->%s) {\n" field1 field2;
7420 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7421 test_name field1 field2;
7422 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7425 | CompareFieldsStrEq (field1, field2) ->
7426 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7427 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7428 test_name field1 field2;
7429 pr " r->%s, r->%s);\n" field1 field2;
7434 List.iter (generate_test_command_call test_name) seq;
7435 generate_test_command_call ~test test_name last
7436 | TestLastFail seq ->
7437 pr " /* TestLastFail for %s (%d) */\n" name i;
7438 let seq, last = get_seq_last seq in
7439 List.iter (generate_test_command_call test_name) seq;
7440 generate_test_command_call test_name ~expect_error:true last
7442 (* Generate the code to run a command, leaving the result in 'r'.
7443 * If you expect to get an error then you should set expect_error:true.
7445 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7447 | [] -> assert false
7449 (* Look up the command to find out what args/ret it has. *)
7452 let _, style, _, _, _, _, _ =
7453 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7456 failwithf "%s: in test, command %s was not found" test_name name in
7458 if List.length (snd style) <> List.length args then
7459 failwithf "%s: in test, wrong number of args given to %s"
7466 | OptString n, "NULL" -> ()
7469 | Dev_or_Path n, arg
7471 | OptString n, arg ->
7472 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7473 | BufferIn n, arg ->
7474 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7475 pr " size_t %s_size = %d;\n" n (String.length arg)
7479 | FileIn _, _ | FileOut _, _ -> ()
7480 | StringList n, "" | DeviceList n, "" ->
7481 pr " const char *const %s[1] = { NULL };\n" n
7482 | StringList n, arg | DeviceList n, arg ->
7483 let strs = string_split " " arg in
7486 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7488 pr " const char *const %s[] = {\n" n;
7490 fun i _ -> pr " %s_%d,\n" n i
7494 ) (List.combine (snd style) args);
7497 match fst style with
7498 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7499 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7500 | RConstString _ | RConstOptString _ ->
7501 pr " const char *r;\n"; "NULL"
7502 | RString _ -> pr " char *r;\n"; "NULL"
7503 | RStringList _ | RHashtable _ ->
7507 | RStruct (_, typ) ->
7508 pr " struct guestfs_%s *r;\n" typ; "NULL"
7509 | RStructList (_, typ) ->
7510 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7513 pr " size_t size;\n";
7516 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7517 pr " r = guestfs_%s (g" name;
7519 (* Generate the parameters. *)
7522 | OptString _, "NULL" -> pr ", NULL"
7524 | Device n, _ | Dev_or_Path n, _
7529 pr ", %s, %s_size" n n
7530 | FileIn _, arg | FileOut _, arg ->
7531 pr ", \"%s\"" (c_quote arg)
7532 | StringList n, _ | DeviceList n, _ ->
7533 pr ", (char **) %s" n
7536 try int_of_string arg
7537 with Failure "int_of_string" ->
7538 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7542 try Int64.of_string arg
7543 with Failure "int_of_string" ->
7544 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7547 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7548 ) (List.combine (snd style) args);
7550 (match fst style with
7551 | RBufferOut _ -> pr ", &size"
7557 if not expect_error then
7558 pr " if (r == %s)\n" error_code
7560 pr " if (r != %s)\n" error_code;
7563 (* Insert the test code. *)
7569 (match fst style with
7570 | RErr | RInt _ | RInt64 _ | RBool _
7571 | RConstString _ | RConstOptString _ -> ()
7572 | RString _ | RBufferOut _ -> pr " free (r);\n"
7573 | RStringList _ | RHashtable _ ->
7574 pr " for (i = 0; r[i] != NULL; ++i)\n";
7575 pr " free (r[i]);\n";
7577 | RStruct (_, typ) ->
7578 pr " guestfs_free_%s (r);\n" typ
7579 | RStructList (_, typ) ->
7580 pr " guestfs_free_%s_list (r);\n" typ
7586 let str = replace_str str "\r" "\\r" in
7587 let str = replace_str str "\n" "\\n" in
7588 let str = replace_str str "\t" "\\t" in
7589 let str = replace_str str "\000" "\\0" in
7592 (* Generate a lot of different functions for guestfish. *)
7593 and generate_fish_cmds () =
7594 generate_header CStyle GPLv2plus;
7598 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7600 let all_functions_sorted =
7602 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7603 ) all_functions_sorted in
7605 pr "#include <config.h>\n";
7607 pr "#include <stdio.h>\n";
7608 pr "#include <stdlib.h>\n";
7609 pr "#include <string.h>\n";
7610 pr "#include <inttypes.h>\n";
7612 pr "#include <guestfs.h>\n";
7613 pr "#include \"c-ctype.h\"\n";
7614 pr "#include \"full-write.h\"\n";
7615 pr "#include \"xstrtol.h\"\n";
7616 pr "#include \"fish.h\"\n";
7618 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7619 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7622 (* list_commands function, which implements guestfish -h *)
7623 pr "void list_commands (void)\n";
7625 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7626 pr " list_builtin_commands ();\n";
7628 fun (name, _, _, flags, _, shortdesc, _) ->
7629 let name = replace_char name '_' '-' in
7630 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7632 ) all_functions_sorted;
7633 pr " printf (\" %%s\\n\",";
7634 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7638 (* display_command function, which implements guestfish -h cmd *)
7639 pr "int display_command (const char *cmd)\n";
7642 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7643 let name2 = replace_char name '_' '-' in
7645 try find_map (function FishAlias n -> Some n | _ -> None) flags
7646 with Not_found -> name in
7647 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7649 match snd style with
7653 name2 (String.concat " " (List.map name_of_argt args)) in
7656 if List.mem ProtocolLimitWarning flags then
7657 ("\n\n" ^ protocol_limit_warning)
7660 (* For DangerWillRobinson commands, we should probably have
7661 * guestfish prompt before allowing you to use them (especially
7662 * in interactive mode). XXX
7666 if List.mem DangerWillRobinson flags then
7667 ("\n\n" ^ danger_will_robinson)
7672 match deprecation_notice flags with
7674 | Some txt -> "\n\n" ^ txt in
7676 let describe_alias =
7677 if name <> alias then
7678 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7682 pr "STRCASEEQ (cmd, \"%s\")" name;
7683 if name <> name2 then
7684 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7685 if name <> alias then
7686 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7688 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7690 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7691 "=head1 DESCRIPTION\n\n" ^
7692 longdesc ^ warnings ^ describe_alias);
7697 pr " return display_builtin_command (cmd);\n";
7701 let emit_print_list_function typ =
7702 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7705 pr " unsigned int i;\n";
7707 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7708 pr " printf (\"[%%d] = {\\n\", i);\n";
7709 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7710 pr " printf (\"}\\n\");\n";
7716 (* print_* functions *)
7720 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7722 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7725 pr " unsigned int i;\n";
7731 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7733 pr " printf (\"%%s%s: \", indent);\n" name;
7734 pr " for (i = 0; i < 32; ++i)\n";
7735 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7736 pr " printf (\"\\n\");\n"
7738 pr " printf (\"%%s%s: \", indent);\n" name;
7739 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7740 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7741 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7743 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7744 pr " printf (\"\\n\");\n"
7745 | name, (FUInt64|FBytes) ->
7746 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7749 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7752 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7755 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7758 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7760 | name, FOptPercent ->
7761 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7762 typ name name typ name;
7763 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7769 (* Emit a print_TYPE_list function definition only if that function is used. *)
7772 | typ, (RStructListOnly | RStructAndList) ->
7773 (* generate the function for typ *)
7774 emit_print_list_function typ
7775 | typ, _ -> () (* empty *)
7776 ) (rstructs_used_by all_functions);
7778 (* Emit a print_TYPE function definition only if that function is used. *)
7781 | typ, (RStructOnly | RStructAndList) ->
7782 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7784 pr " print_%s_indent (%s, \"\");\n" typ typ;
7787 | typ, _ -> () (* empty *)
7788 ) (rstructs_used_by all_functions);
7790 (* run_<action> actions *)
7792 fun (name, style, _, flags, _, _, _) ->
7793 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7795 (match fst style with
7798 | RBool _ -> pr " int r;\n"
7799 | RInt64 _ -> pr " int64_t r;\n"
7800 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7801 | RString _ -> pr " char *r;\n"
7802 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7803 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7804 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7807 pr " size_t size;\n";
7813 | OptString n -> pr " const char *%s;\n" n
7817 | FileOut n -> pr " char *%s;\n" n
7819 pr " const char *%s;\n" n;
7820 pr " size_t %s_size;\n" n
7821 | StringList n | DeviceList n -> pr " char **%s;\n" n
7822 | Bool n -> pr " int %s;\n" n
7823 | Int n -> pr " int %s;\n" n
7824 | Int64 n -> pr " int64_t %s;\n" n
7827 (* Check and convert parameters. *)
7828 let argc_expected = List.length (snd style) in
7829 pr " if (argc != %d) {\n" argc_expected;
7830 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7832 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7836 let parse_integer fn fntyp rtyp range name i =
7838 pr " strtol_error xerr;\n";
7839 pr " %s r;\n" fntyp;
7841 pr " xerr = %s (argv[%d], NULL, 0, &r, xstrtol_suffixes);\n" fn i;
7842 pr " if (xerr != LONGINT_OK) {\n";
7843 pr " fprintf (stderr,\n";
7844 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7845 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7850 | Some (min, max, comment) ->
7851 pr " /* %s */\n" comment;
7852 pr " if (r < %s || r > %s) {\n" min max;
7853 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7857 pr " /* The check above should ensure this assignment does not overflow. */\n";
7859 pr " %s = r;\n" name;
7868 pr " %s = argv[%d];\n" name i
7870 | Dev_or_Path name ->
7871 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7872 pr " if (%s == NULL) return -1;\n" name
7874 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7877 pr " %s = argv[%d];\n" name i;
7878 pr " %s_size = strlen (argv[%d]);\n" name i
7880 pr " %s = file_in (argv[%d]);\n" name i;
7881 pr " if (%s == NULL) return -1;\n" name
7883 pr " %s = file_out (argv[%d]);\n" name i;
7884 pr " if (%s == NULL) return -1;\n" name
7885 | StringList name | DeviceList name ->
7886 pr " %s = parse_string_list (argv[%d]);\n" name i;
7887 pr " if (%s == NULL) return -1;\n" name;
7889 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7892 let min = "(-(2LL<<30))"
7893 and max = "((2LL<<30)-1)"
7895 "The Int type in the generator is a signed 31 bit int." in
7896 Some (min, max, comment) in
7897 parse_integer "xstrtoll" "long long" "int" range name i
7899 parse_integer "xstrtoll" "long long" "int64_t" None name i
7902 (* Call C API function. *)
7903 pr " r = guestfs_%s " name;
7904 generate_c_call_args ~handle:"g" style;
7909 | Device name | String name
7910 | OptString name | Bool name
7911 | Int name | Int64 name
7912 | BufferIn name -> ()
7913 | Pathname name | Dev_or_Path name | FileOut name ->
7914 pr " free (%s);\n" name
7916 pr " free_file_in (%s);\n" name
7917 | StringList name | DeviceList name ->
7918 pr " free_strings (%s);\n" name
7921 (* Any output flags? *)
7923 let flags = filter_map (
7924 function FishOutput flag -> Some flag | _ -> None
7930 failwithf "%s: more than one FishOutput flag is not allowed" name in
7932 (* Check return value for errors and display command results. *)
7933 (match fst style with
7934 | RErr -> pr " return r;\n"
7936 pr " if (r == -1) return -1;\n";
7937 (match fish_output with
7939 pr " printf (\"%%d\\n\", r);\n";
7940 | Some FishOutputOctal ->
7941 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7942 | Some FishOutputHexadecimal ->
7943 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7946 pr " if (r == -1) return -1;\n";
7947 (match fish_output with
7949 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7950 | Some FishOutputOctal ->
7951 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7952 | Some FishOutputHexadecimal ->
7953 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7956 pr " if (r == -1) return -1;\n";
7957 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7960 pr " if (r == NULL) return -1;\n";
7961 pr " printf (\"%%s\\n\", r);\n";
7963 | RConstOptString _ ->
7964 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7967 pr " if (r == NULL) return -1;\n";
7968 pr " printf (\"%%s\\n\", r);\n";
7972 pr " if (r == NULL) return -1;\n";
7973 pr " print_strings (r);\n";
7974 pr " free_strings (r);\n";
7976 | RStruct (_, typ) ->
7977 pr " if (r == NULL) return -1;\n";
7978 pr " print_%s (r);\n" typ;
7979 pr " guestfs_free_%s (r);\n" typ;
7981 | RStructList (_, typ) ->
7982 pr " if (r == NULL) return -1;\n";
7983 pr " print_%s_list (r);\n" typ;
7984 pr " guestfs_free_%s_list (r);\n" typ;
7987 pr " if (r == NULL) return -1;\n";
7988 pr " print_table (r);\n";
7989 pr " free_strings (r);\n";
7992 pr " if (r == NULL) return -1;\n";
7993 pr " if (full_write (1, r, size) != size) {\n";
7994 pr " perror (\"write\");\n";
8005 (* run_action function *)
8006 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
8009 fun (name, _, _, flags, _, _, _) ->
8010 let name2 = replace_char name '_' '-' in
8012 try find_map (function FishAlias n -> Some n | _ -> None) flags
8013 with Not_found -> name in
8015 pr "STRCASEEQ (cmd, \"%s\")" name;
8016 if name <> name2 then
8017 pr " || STRCASEEQ (cmd, \"%s\")" name2;
8018 if name <> alias then
8019 pr " || STRCASEEQ (cmd, \"%s\")" alias;
8021 pr " return run_%s (cmd, argc, argv);\n" name;
8025 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
8026 pr " if (command_num == 1)\n";
8027 pr " extended_help_message ();\n";
8034 (* Readline completion for guestfish. *)
8035 and generate_fish_completion () =
8036 generate_header CStyle GPLv2plus;
8040 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8050 #ifdef HAVE_LIBREADLINE
8051 #include <readline/readline.h>
8056 #ifdef HAVE_LIBREADLINE
8058 static const char *const commands[] = {
8059 BUILTIN_COMMANDS_FOR_COMPLETION,
8062 (* Get the commands, including the aliases. They don't need to be
8063 * sorted - the generator() function just does a dumb linear search.
8067 fun (name, _, _, flags, _, _, _) ->
8068 let name2 = replace_char name '_' '-' in
8070 try find_map (function FishAlias n -> Some n | _ -> None) flags
8071 with Not_found -> name in
8073 if name <> alias then [name2; alias] else [name2]
8075 let commands = List.flatten commands in
8077 List.iter (pr " \"%s\",\n") commands;
8083 generator (const char *text, int state)
8085 static int index, len;
8090 len = strlen (text);
8093 rl_attempted_completion_over = 1;
8095 while ((name = commands[index]) != NULL) {
8097 if (STRCASEEQLEN (name, text, len))
8098 return strdup (name);
8104 #endif /* HAVE_LIBREADLINE */
8106 #ifdef HAVE_RL_COMPLETION_MATCHES
8107 #define RL_COMPLETION_MATCHES rl_completion_matches
8109 #ifdef HAVE_COMPLETION_MATCHES
8110 #define RL_COMPLETION_MATCHES completion_matches
8112 #endif /* else just fail if we don't have either symbol */
8115 do_completion (const char *text, int start, int end)
8117 char **matches = NULL;
8119 #ifdef HAVE_LIBREADLINE
8120 rl_completion_append_character = ' ';
8123 matches = RL_COMPLETION_MATCHES (text, generator);
8124 else if (complete_dest_paths)
8125 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
8132 (* Generate the POD documentation for guestfish. *)
8133 and generate_fish_actions_pod () =
8134 let all_functions_sorted =
8136 fun (_, _, _, flags, _, _, _) ->
8137 not (List.mem NotInFish flags || List.mem NotInDocs flags)
8138 ) all_functions_sorted in
8140 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8143 fun (name, style, _, flags, _, _, longdesc) ->
8145 Str.global_substitute rex (
8148 try Str.matched_group 1 s
8150 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8151 "C<" ^ replace_char sub '_' '-' ^ ">"
8153 let name = replace_char name '_' '-' in
8155 try find_map (function FishAlias n -> Some n | _ -> None) flags
8156 with Not_found -> name in
8158 pr "=head2 %s" name;
8159 if name <> alias then
8166 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
8167 | OptString n -> pr " %s" n
8168 | StringList n | DeviceList n -> pr " '%s ...'" n
8169 | Bool _ -> pr " true|false"
8170 | Int n -> pr " %s" n
8171 | Int64 n -> pr " %s" n
8172 | FileIn n | FileOut n -> pr " (%s|-)" n
8173 | BufferIn n -> pr " %s" n
8177 pr "%s\n\n" longdesc;
8179 if List.exists (function FileIn _ | FileOut _ -> true
8180 | _ -> false) (snd style) then
8181 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8183 if List.mem ProtocolLimitWarning flags then
8184 pr "%s\n\n" protocol_limit_warning;
8186 if List.mem DangerWillRobinson flags then
8187 pr "%s\n\n" danger_will_robinson;
8189 match deprecation_notice flags with
8191 | Some txt -> pr "%s\n\n" txt
8192 ) all_functions_sorted
8194 (* Generate a C function prototype. *)
8195 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8196 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8198 ?handle name style =
8199 if extern then pr "extern ";
8200 if static then pr "static ";
8201 (match fst style with
8203 | RInt _ -> pr "int "
8204 | RInt64 _ -> pr "int64_t "
8205 | RBool _ -> pr "int "
8206 | RConstString _ | RConstOptString _ -> pr "const char *"
8207 | RString _ | RBufferOut _ -> pr "char *"
8208 | RStringList _ | RHashtable _ -> pr "char **"
8209 | RStruct (_, typ) ->
8210 if not in_daemon then pr "struct guestfs_%s *" typ
8211 else pr "guestfs_int_%s *" typ
8212 | RStructList (_, typ) ->
8213 if not in_daemon then pr "struct guestfs_%s_list *" typ
8214 else pr "guestfs_int_%s_list *" typ
8216 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8217 pr "%s%s (" prefix name;
8218 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8221 let comma = ref false in
8224 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8228 if single_line then pr ", " else pr ",\n\t\t"
8235 | Device n | Dev_or_Path n
8239 pr "const char *%s" n
8240 | StringList n | DeviceList n ->
8242 pr "char *const *%s" n
8243 | Bool n -> next (); pr "int %s" n
8244 | Int n -> next (); pr "int %s" n
8245 | Int64 n -> next (); pr "int64_t %s" n
8248 if not in_daemon then (next (); pr "const char *%s" n)
8251 pr "const char *%s" n;
8253 pr "size_t %s_size" n
8255 if is_RBufferOut then (next (); pr "size_t *size_r");
8258 if semicolon then pr ";";
8259 if newline then pr "\n"
8261 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8262 and generate_c_call_args ?handle ?(decl = false) style =
8264 let comma = ref false in
8266 if !comma then pr ", ";
8271 | Some handle -> pr "%s" handle; comma := true
8277 pr "%s, %s_size" n n
8280 pr "%s" (name_of_argt arg)
8282 (* For RBufferOut calls, add implicit &size parameter. *)
8284 match fst style with
8292 (* Generate the OCaml bindings interface. *)
8293 and generate_ocaml_mli () =
8294 generate_header OCamlStyle LGPLv2plus;
8297 (** For API documentation you should refer to the C API
8298 in the guestfs(3) manual page. The OCaml API uses almost
8299 exactly the same calls. *)
8302 (** A [guestfs_h] handle. *)
8304 exception Error of string
8305 (** This exception is raised when there is an error. *)
8307 exception Handle_closed of string
8308 (** This exception is raised if you use a {!Guestfs.t} handle
8309 after calling {!close} on it. The string is the name of
8312 val create : unit -> t
8313 (** Create a {!Guestfs.t} handle. *)
8315 val close : t -> unit
8316 (** Close the {!Guestfs.t} handle and free up all resources used
8319 Handles are closed by the garbage collector when they become
8320 unreferenced, but callers can call this in order to provide
8321 predictable cleanup. *)
8324 generate_ocaml_structure_decls ();
8328 fun (name, style, _, _, _, shortdesc, _) ->
8329 generate_ocaml_prototype name style;
8330 pr "(** %s *)\n" shortdesc;
8332 ) all_functions_sorted
8334 (* Generate the OCaml bindings implementation. *)
8335 and generate_ocaml_ml () =
8336 generate_header OCamlStyle LGPLv2plus;
8341 exception Error of string
8342 exception Handle_closed of string
8344 external create : unit -> t = \"ocaml_guestfs_create\"
8345 external close : t -> unit = \"ocaml_guestfs_close\"
8347 (* Give the exceptions names, so they can be raised from the C code. *)
8349 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8350 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8354 generate_ocaml_structure_decls ();
8358 fun (name, style, _, _, _, shortdesc, _) ->
8359 generate_ocaml_prototype ~is_external:true name style;
8360 ) all_functions_sorted
8362 (* Generate the OCaml bindings C implementation. *)
8363 and generate_ocaml_c () =
8364 generate_header CStyle LGPLv2plus;
8371 #include <caml/config.h>
8372 #include <caml/alloc.h>
8373 #include <caml/callback.h>
8374 #include <caml/fail.h>
8375 #include <caml/memory.h>
8376 #include <caml/mlvalues.h>
8377 #include <caml/signals.h>
8379 #include <guestfs.h>
8381 #include \"guestfs_c.h\"
8383 /* Copy a hashtable of string pairs into an assoc-list. We return
8384 * the list in reverse order, but hashtables aren't supposed to be
8387 static CAMLprim value
8388 copy_table (char * const * argv)
8391 CAMLlocal5 (rv, pairv, kv, vv, cons);
8395 for (i = 0; argv[i] != NULL; i += 2) {
8396 kv = caml_copy_string (argv[i]);
8397 vv = caml_copy_string (argv[i+1]);
8398 pairv = caml_alloc (2, 0);
8399 Store_field (pairv, 0, kv);
8400 Store_field (pairv, 1, vv);
8401 cons = caml_alloc (2, 0);
8402 Store_field (cons, 1, rv);
8404 Store_field (cons, 0, pairv);
8412 (* Struct copy functions. *)
8414 let emit_ocaml_copy_list_function typ =
8415 pr "static CAMLprim value\n";
8416 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8418 pr " CAMLparam0 ();\n";
8419 pr " CAMLlocal2 (rv, v);\n";
8420 pr " unsigned int i;\n";
8422 pr " if (%ss->len == 0)\n" typ;
8423 pr " CAMLreturn (Atom (0));\n";
8425 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8426 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8427 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8428 pr " caml_modify (&Field (rv, i), v);\n";
8430 pr " CAMLreturn (rv);\n";
8438 let has_optpercent_col =
8439 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8441 pr "static CAMLprim value\n";
8442 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8444 pr " CAMLparam0 ();\n";
8445 if has_optpercent_col then
8446 pr " CAMLlocal3 (rv, v, v2);\n"
8448 pr " CAMLlocal2 (rv, v);\n";
8450 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8455 pr " v = caml_copy_string (%s->%s);\n" typ name
8457 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8458 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8461 pr " v = caml_alloc_string (32);\n";
8462 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8463 | name, (FBytes|FInt64|FUInt64) ->
8464 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8465 | name, (FInt32|FUInt32) ->
8466 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8467 | name, FOptPercent ->
8468 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8469 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8470 pr " v = caml_alloc (1, 0);\n";
8471 pr " Store_field (v, 0, v2);\n";
8472 pr " } else /* None */\n";
8473 pr " v = Val_int (0);\n";
8475 pr " v = Val_int (%s->%s);\n" typ name
8477 pr " Store_field (rv, %d, v);\n" i
8479 pr " CAMLreturn (rv);\n";
8484 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8487 | typ, (RStructListOnly | RStructAndList) ->
8488 (* generate the function for typ *)
8489 emit_ocaml_copy_list_function typ
8490 | typ, _ -> () (* empty *)
8491 ) (rstructs_used_by all_functions);
8495 fun (name, style, _, _, _, _, _) ->
8496 pr "/* Automatically generated wrapper for function\n";
8498 generate_ocaml_prototype name style;
8503 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8505 let needs_extra_vs =
8506 match fst style with RConstOptString _ -> true | _ -> false in
8508 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8509 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8510 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8513 pr "CAMLprim value\n";
8514 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8515 List.iter (pr ", value %s") (List.tl params);
8520 | [p1; p2; p3; p4; p5] ->
8521 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8522 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8523 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8524 pr " CAMLxparam%d (%s);\n"
8525 (List.length rest) (String.concat ", " rest)
8527 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8529 if not needs_extra_vs then
8530 pr " CAMLlocal1 (rv);\n"
8532 pr " CAMLlocal3 (rv, v, v2);\n";
8535 pr " guestfs_h *g = Guestfs_val (gv);\n";
8536 pr " if (g == NULL)\n";
8537 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8543 | Device n | Dev_or_Path n
8547 pr " const char *%s = String_val (%sv);\n" n n
8549 pr " const char *%s =\n" n;
8550 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8553 pr " const char *%s = String_val (%sv);\n" n n;
8554 pr " size_t %s_size = caml_string_length (%sv);\n" n n
8555 | StringList n | DeviceList n ->
8556 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8558 pr " int %s = Bool_val (%sv);\n" n n
8560 pr " int %s = Int_val (%sv);\n" n n
8562 pr " int64_t %s = Int64_val (%sv);\n" n n
8565 match fst style with
8566 | RErr -> pr " int r;\n"; "-1"
8567 | RInt _ -> pr " int r;\n"; "-1"
8568 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8569 | RBool _ -> pr " int r;\n"; "-1"
8570 | RConstString _ | RConstOptString _ ->
8571 pr " const char *r;\n"; "NULL"
8572 | RString _ -> pr " char *r;\n"; "NULL"
8577 | RStruct (_, typ) ->
8578 pr " struct guestfs_%s *r;\n" typ; "NULL"
8579 | RStructList (_, typ) ->
8580 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8587 pr " size_t size;\n";
8591 pr " caml_enter_blocking_section ();\n";
8592 pr " r = guestfs_%s " name;
8593 generate_c_call_args ~handle:"g" style;
8595 pr " caml_leave_blocking_section ();\n";
8599 | StringList n | DeviceList n ->
8600 pr " ocaml_guestfs_free_strings (%s);\n" n;
8601 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8602 | Bool _ | Int _ | Int64 _
8603 | FileIn _ | FileOut _ | BufferIn _ -> ()
8606 pr " if (r == %s)\n" error_code;
8607 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8610 (match fst style with
8611 | RErr -> pr " rv = Val_unit;\n"
8612 | RInt _ -> pr " rv = Val_int (r);\n"
8614 pr " rv = caml_copy_int64 (r);\n"
8615 | RBool _ -> pr " rv = Val_bool (r);\n"
8617 pr " rv = caml_copy_string (r);\n"
8618 | RConstOptString _ ->
8619 pr " if (r) { /* Some string */\n";
8620 pr " v = caml_alloc (1, 0);\n";
8621 pr " v2 = caml_copy_string (r);\n";
8622 pr " Store_field (v, 0, v2);\n";
8623 pr " } else /* None */\n";
8624 pr " v = Val_int (0);\n";
8626 pr " rv = caml_copy_string (r);\n";
8629 pr " rv = caml_copy_string_array ((const char **) r);\n";
8630 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8632 | RStruct (_, typ) ->
8633 pr " rv = copy_%s (r);\n" typ;
8634 pr " guestfs_free_%s (r);\n" typ;
8635 | RStructList (_, typ) ->
8636 pr " rv = copy_%s_list (r);\n" typ;
8637 pr " guestfs_free_%s_list (r);\n" typ;
8639 pr " rv = copy_table (r);\n";
8640 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8643 pr " rv = caml_alloc_string (size);\n";
8644 pr " memcpy (String_val (rv), r, size);\n";
8647 pr " CAMLreturn (rv);\n";
8651 if List.length params > 5 then (
8652 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8653 pr "CAMLprim value ";
8654 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8655 pr "CAMLprim value\n";
8656 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8658 pr " return ocaml_guestfs_%s (argv[0]" name;
8659 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8664 ) all_functions_sorted
8666 and generate_ocaml_structure_decls () =
8669 pr "type %s = {\n" typ;
8672 | name, FString -> pr " %s : string;\n" name
8673 | name, FBuffer -> pr " %s : string;\n" name
8674 | name, FUUID -> pr " %s : string;\n" name
8675 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8676 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8677 | name, FChar -> pr " %s : char;\n" name
8678 | name, FOptPercent -> pr " %s : float option;\n" name
8684 and generate_ocaml_prototype ?(is_external = false) name style =
8685 if is_external then pr "external " else pr "val ";
8686 pr "%s : t -> " name;
8689 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8690 | BufferIn _ -> pr "string -> "
8691 | OptString _ -> pr "string option -> "
8692 | StringList _ | DeviceList _ -> pr "string array -> "
8693 | Bool _ -> pr "bool -> "
8694 | Int _ -> pr "int -> "
8695 | Int64 _ -> pr "int64 -> "
8697 (match fst style with
8698 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8699 | RInt _ -> pr "int"
8700 | RInt64 _ -> pr "int64"
8701 | RBool _ -> pr "bool"
8702 | RConstString _ -> pr "string"
8703 | RConstOptString _ -> pr "string option"
8704 | RString _ | RBufferOut _ -> pr "string"
8705 | RStringList _ -> pr "string array"
8706 | RStruct (_, typ) -> pr "%s" typ
8707 | RStructList (_, typ) -> pr "%s array" typ
8708 | RHashtable _ -> pr "(string * string) list"
8710 if is_external then (
8712 if List.length (snd style) + 1 > 5 then
8713 pr "\"ocaml_guestfs_%s_byte\" " name;
8714 pr "\"ocaml_guestfs_%s\"" name
8718 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8719 and generate_perl_xs () =
8720 generate_header CStyle LGPLv2plus;
8723 #include \"EXTERN.h\"
8727 #include <guestfs.h>
8730 #define PRId64 \"lld\"
8734 my_newSVll(long long val) {
8735 #ifdef USE_64_BIT_ALL
8736 return newSViv(val);
8740 len = snprintf(buf, 100, \"%%\" PRId64, val);
8741 return newSVpv(buf, len);
8746 #define PRIu64 \"llu\"
8750 my_newSVull(unsigned long long val) {
8751 #ifdef USE_64_BIT_ALL
8752 return newSVuv(val);
8756 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8757 return newSVpv(buf, len);
8761 /* http://www.perlmonks.org/?node_id=680842 */
8763 XS_unpack_charPtrPtr (SV *arg) {
8768 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8769 croak (\"array reference expected\");
8771 av = (AV *)SvRV (arg);
8772 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8774 croak (\"malloc failed\");
8776 for (i = 0; i <= av_len (av); i++) {
8777 SV **elem = av_fetch (av, i, 0);
8779 if (!elem || !*elem)
8780 croak (\"missing element in list\");
8782 ret[i] = SvPV_nolen (*elem);
8790 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8797 RETVAL = guestfs_create ();
8799 croak (\"could not create guestfs handle\");
8800 guestfs_set_error_handler (RETVAL, NULL, NULL);
8813 fun (name, style, _, _, _, _, _) ->
8814 (match fst style with
8815 | RErr -> pr "void\n"
8816 | RInt _ -> pr "SV *\n"
8817 | RInt64 _ -> pr "SV *\n"
8818 | RBool _ -> pr "SV *\n"
8819 | RConstString _ -> pr "SV *\n"
8820 | RConstOptString _ -> pr "SV *\n"
8821 | RString _ -> pr "SV *\n"
8822 | RBufferOut _ -> pr "SV *\n"
8824 | RStruct _ | RStructList _
8826 pr "void\n" (* all lists returned implictly on the stack *)
8828 (* Call and arguments. *)
8831 fun arg -> pr ", %s" (name_of_argt arg)
8834 pr " guestfs_h *g;\n";
8838 | Pathname n | Device n | Dev_or_Path n | String n
8839 | FileIn n | FileOut n ->
8842 pr " char *%s;\n" n;
8843 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
8845 (* http://www.perlmonks.org/?node_id=554277
8846 * Note that the implicit handle argument means we have
8847 * to add 1 to the ST(x) operator.
8849 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8850 | StringList n | DeviceList n -> pr " char **%s;\n" n
8851 | Bool n -> pr " int %s;\n" n
8852 | Int n -> pr " int %s;\n" n
8853 | Int64 n -> pr " int64_t %s;\n" n
8856 let do_cleanups () =
8859 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8860 | Bool _ | Int _ | Int64 _
8861 | FileIn _ | FileOut _
8863 | StringList n | DeviceList n -> pr " free (%s);\n" n
8868 (match fst style with
8873 pr " r = guestfs_%s " name;
8874 generate_c_call_args ~handle:"g" style;
8877 pr " if (r == -1)\n";
8878 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8884 pr " %s = guestfs_%s " n name;
8885 generate_c_call_args ~handle:"g" style;
8888 pr " if (%s == -1)\n" n;
8889 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8890 pr " RETVAL = newSViv (%s);\n" n;
8895 pr " int64_t %s;\n" n;
8897 pr " %s = guestfs_%s " n name;
8898 generate_c_call_args ~handle:"g" style;
8901 pr " if (%s == -1)\n" n;
8902 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8903 pr " RETVAL = my_newSVll (%s);\n" n;
8908 pr " const char *%s;\n" n;
8910 pr " %s = guestfs_%s " n name;
8911 generate_c_call_args ~handle:"g" style;
8914 pr " if (%s == NULL)\n" n;
8915 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8916 pr " RETVAL = newSVpv (%s, 0);\n" n;
8919 | RConstOptString n ->
8921 pr " const char *%s;\n" n;
8923 pr " %s = guestfs_%s " n name;
8924 generate_c_call_args ~handle:"g" style;
8927 pr " if (%s == NULL)\n" n;
8928 pr " RETVAL = &PL_sv_undef;\n";
8930 pr " RETVAL = newSVpv (%s, 0);\n" n;
8935 pr " char *%s;\n" n;
8937 pr " %s = guestfs_%s " n name;
8938 generate_c_call_args ~handle:"g" style;
8941 pr " if (%s == NULL)\n" n;
8942 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8943 pr " RETVAL = newSVpv (%s, 0);\n" n;
8944 pr " free (%s);\n" n;
8947 | RStringList n | RHashtable n ->
8949 pr " char **%s;\n" n;
8952 pr " %s = guestfs_%s " n name;
8953 generate_c_call_args ~handle:"g" style;
8956 pr " if (%s == NULL)\n" n;
8957 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8958 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8959 pr " EXTEND (SP, n);\n";
8960 pr " for (i = 0; i < n; ++i) {\n";
8961 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8962 pr " free (%s[i]);\n" n;
8964 pr " free (%s);\n" n;
8965 | RStruct (n, typ) ->
8966 let cols = cols_of_struct typ in
8967 generate_perl_struct_code typ cols name style n do_cleanups
8968 | RStructList (n, typ) ->
8969 let cols = cols_of_struct typ in
8970 generate_perl_struct_list_code typ cols name style n do_cleanups
8973 pr " char *%s;\n" n;
8974 pr " size_t size;\n";
8976 pr " %s = guestfs_%s " n name;
8977 generate_c_call_args ~handle:"g" style;
8980 pr " if (%s == NULL)\n" n;
8981 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8982 pr " RETVAL = newSVpvn (%s, size);\n" n;
8983 pr " free (%s);\n" n;
8991 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8993 pr " struct guestfs_%s_list *%s;\n" typ n;
8997 pr " %s = guestfs_%s " n name;
8998 generate_c_call_args ~handle:"g" style;
9001 pr " if (%s == NULL)\n" n;
9002 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9003 pr " EXTEND (SP, %s->len);\n" n;
9004 pr " for (i = 0; i < %s->len; ++i) {\n" n;
9005 pr " hv = newHV ();\n";
9009 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
9010 name (String.length name) n name
9012 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
9013 name (String.length name) n name
9015 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
9016 name (String.length name) n name n name
9017 | name, (FBytes|FUInt64) ->
9018 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
9019 name (String.length name) n name
9021 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
9022 name (String.length name) n name
9023 | name, (FInt32|FUInt32) ->
9024 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9025 name (String.length name) n name
9027 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
9028 name (String.length name) n name
9029 | name, FOptPercent ->
9030 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9031 name (String.length name) n name
9033 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
9035 pr " guestfs_free_%s_list (%s);\n" typ n
9037 and generate_perl_struct_code typ cols name style n do_cleanups =
9039 pr " struct guestfs_%s *%s;\n" typ n;
9041 pr " %s = guestfs_%s " n name;
9042 generate_c_call_args ~handle:"g" style;
9045 pr " if (%s == NULL)\n" n;
9046 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9047 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
9049 fun ((name, _) as col) ->
9050 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
9054 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
9057 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
9060 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
9062 | name, (FBytes|FUInt64) ->
9063 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
9066 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
9068 | name, (FInt32|FUInt32) ->
9069 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9072 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
9074 | name, FOptPercent ->
9075 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9078 pr " free (%s);\n" n
9080 (* Generate Sys/Guestfs.pm. *)
9081 and generate_perl_pm () =
9082 generate_header HashStyle LGPLv2plus;
9089 Sys::Guestfs - Perl bindings for libguestfs
9095 my $h = Sys::Guestfs->new ();
9096 $h->add_drive ('guest.img');
9098 $h->mount ('/dev/sda1', '/');
9099 $h->touch ('/hello');
9104 The C<Sys::Guestfs> module provides a Perl XS binding to the
9105 libguestfs API for examining and modifying virtual machine
9108 Amongst the things this is good for: making batch configuration
9109 changes to guests, getting disk used/free statistics (see also:
9110 virt-df), migrating between virtualization systems (see also:
9111 virt-p2v), performing partial backups, performing partial guest
9112 clones, cloning guests and changing registry/UUID/hostname info, and
9115 Libguestfs uses Linux kernel and qemu code, and can access any type of
9116 guest filesystem that Linux and qemu can, including but not limited
9117 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9118 schemes, qcow, qcow2, vmdk.
9120 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9121 LVs, what filesystem is in each LV, etc.). It can also run commands
9122 in the context of the guest. Also you can access filesystems over
9125 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
9126 functions for using libguestfs from Perl, including integration
9131 All errors turn into calls to C<croak> (see L<Carp(3)>).
9139 package Sys::Guestfs;
9144 # This version number changes whenever a new function
9145 # is added to the libguestfs API. It is not directly
9146 # related to the libguestfs version number.
9147 use vars qw($VERSION);
9151 XSLoader::load ('Sys::Guestfs');
9153 =item $h = Sys::Guestfs->new ();
9155 Create a new guestfs handle.
9161 my $class = ref ($proto) || $proto;
9163 my $self = Sys::Guestfs::_create ();
9164 bless $self, $class;
9170 (* Actions. We only need to print documentation for these as
9171 * they are pulled in from the XS code automatically.
9174 fun (name, style, _, flags, _, _, longdesc) ->
9175 if not (List.mem NotInDocs flags) then (
9176 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9178 generate_perl_prototype name style;
9180 pr "%s\n\n" longdesc;
9181 if List.mem ProtocolLimitWarning flags then
9182 pr "%s\n\n" protocol_limit_warning;
9183 if List.mem DangerWillRobinson flags then
9184 pr "%s\n\n" danger_will_robinson;
9185 match deprecation_notice flags with
9187 | Some txt -> pr "%s\n\n" txt
9189 ) all_functions_sorted;
9201 Copyright (C) %s Red Hat Inc.
9205 Please see the file COPYING.LIB for the full license.
9211 L<http://libguestfs.org>,
9212 L<Sys::Guestfs::Lib(3)>.
9217 and generate_perl_prototype name style =
9218 (match fst style with
9226 | RBufferOut n -> pr "$%s = " n
9228 | RHashtable n -> pr "%%%s = " n
9230 | RStructList (n,_) -> pr "@%s = " n
9233 let comma = ref false in
9236 if !comma then pr ", ";
9239 | Pathname n | Device n | Dev_or_Path n | String n
9240 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9243 | StringList n | DeviceList n ->
9248 (* Generate Python C module. *)
9249 and generate_python_c () =
9250 generate_header CStyle LGPLv2plus;
9253 #define PY_SSIZE_T_CLEAN 1
9256 #if PY_VERSION_HEX < 0x02050000
9257 typedef int Py_ssize_t;
9258 #define PY_SSIZE_T_MAX INT_MAX
9259 #define PY_SSIZE_T_MIN INT_MIN
9266 #include \"guestfs.h\"
9274 get_handle (PyObject *obj)
9277 assert (obj != Py_None);
9278 return ((Pyguestfs_Object *) obj)->g;
9282 put_handle (guestfs_h *g)
9286 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9289 /* This list should be freed (but not the strings) after use. */
9291 get_string_list (PyObject *obj)
9298 if (!PyList_Check (obj)) {
9299 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9303 len = PyList_Size (obj);
9304 r = malloc (sizeof (char *) * (len+1));
9306 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9310 for (i = 0; i < len; ++i)
9311 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9318 put_string_list (char * const * const argv)
9323 for (argc = 0; argv[argc] != NULL; ++argc)
9326 list = PyList_New (argc);
9327 for (i = 0; i < argc; ++i)
9328 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9334 put_table (char * const * const argv)
9336 PyObject *list, *item;
9339 for (argc = 0; argv[argc] != NULL; ++argc)
9342 list = PyList_New (argc >> 1);
9343 for (i = 0; i < argc; i += 2) {
9344 item = PyTuple_New (2);
9345 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9346 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9347 PyList_SetItem (list, i >> 1, item);
9354 free_strings (char **argv)
9358 for (argc = 0; argv[argc] != NULL; ++argc)
9364 py_guestfs_create (PyObject *self, PyObject *args)
9368 g = guestfs_create ();
9370 PyErr_SetString (PyExc_RuntimeError,
9371 \"guestfs.create: failed to allocate handle\");
9374 guestfs_set_error_handler (g, NULL, NULL);
9375 return put_handle (g);
9379 py_guestfs_close (PyObject *self, PyObject *args)
9384 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9386 g = get_handle (py_g);
9390 Py_INCREF (Py_None);
9396 let emit_put_list_function typ =
9397 pr "static PyObject *\n";
9398 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9400 pr " PyObject *list;\n";
9403 pr " list = PyList_New (%ss->len);\n" typ;
9404 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9405 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9406 pr " return list;\n";
9411 (* Structures, turned into Python dictionaries. *)
9414 pr "static PyObject *\n";
9415 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9417 pr " PyObject *dict;\n";
9419 pr " dict = PyDict_New ();\n";
9423 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9424 pr " PyString_FromString (%s->%s));\n"
9427 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9428 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9431 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9432 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9434 | name, (FBytes|FUInt64) ->
9435 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9436 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9439 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9440 pr " PyLong_FromLongLong (%s->%s));\n"
9443 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9444 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9447 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9448 pr " PyLong_FromLong (%s->%s));\n"
9450 | name, FOptPercent ->
9451 pr " if (%s->%s >= 0)\n" typ name;
9452 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9453 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9456 pr " Py_INCREF (Py_None);\n";
9457 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9460 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9461 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9463 pr " return dict;\n";
9469 (* Emit a put_TYPE_list function definition only if that function is used. *)
9472 | typ, (RStructListOnly | RStructAndList) ->
9473 (* generate the function for typ *)
9474 emit_put_list_function typ
9475 | typ, _ -> () (* empty *)
9476 ) (rstructs_used_by all_functions);
9478 (* Python wrapper functions. *)
9480 fun (name, style, _, _, _, _, _) ->
9481 pr "static PyObject *\n";
9482 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9485 pr " PyObject *py_g;\n";
9486 pr " guestfs_h *g;\n";
9487 pr " PyObject *py_r;\n";
9490 match fst style with
9491 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9492 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9493 | RConstString _ | RConstOptString _ ->
9494 pr " const char *r;\n"; "NULL"
9495 | RString _ -> pr " char *r;\n"; "NULL"
9496 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9497 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9498 | RStructList (_, typ) ->
9499 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9502 pr " size_t size;\n";
9507 | Pathname n | Device n | Dev_or_Path n | String n
9508 | FileIn n | FileOut n ->
9509 pr " const char *%s;\n" n
9510 | OptString n -> pr " const char *%s;\n" n
9512 pr " const char *%s;\n" n;
9513 pr " Py_ssize_t %s_size;\n" n
9514 | StringList n | DeviceList n ->
9515 pr " PyObject *py_%s;\n" n;
9516 pr " char **%s;\n" n
9517 | Bool n -> pr " int %s;\n" n
9518 | Int n -> pr " int %s;\n" n
9519 | Int64 n -> pr " long long %s;\n" n
9524 (* Convert the parameters. *)
9525 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9528 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9529 | OptString _ -> pr "z"
9530 | StringList _ | DeviceList _ -> pr "O"
9531 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9533 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9534 * emulate C's int/long/long long in Python?
9536 | BufferIn _ -> pr "s#"
9538 pr ":guestfs_%s\",\n" name;
9542 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9543 | OptString n -> pr ", &%s" n
9544 | StringList n | DeviceList n -> pr ", &py_%s" n
9545 | Bool n -> pr ", &%s" n
9546 | Int n -> pr ", &%s" n
9547 | Int64 n -> pr ", &%s" n
9548 | BufferIn n -> pr ", &%s, &%s_size" n n
9552 pr " return NULL;\n";
9554 pr " g = get_handle (py_g);\n";
9557 | Pathname _ | Device _ | Dev_or_Path _ | String _
9558 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9560 | StringList n | DeviceList n ->
9561 pr " %s = get_string_list (py_%s);\n" n n;
9562 pr " if (!%s) return NULL;\n" n
9567 pr " r = guestfs_%s " name;
9568 generate_c_call_args ~handle:"g" style;
9573 | Pathname _ | Device _ | Dev_or_Path _ | String _
9574 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9576 | StringList n | DeviceList n ->
9577 pr " free (%s);\n" n
9580 pr " if (r == %s) {\n" error_code;
9581 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9582 pr " return NULL;\n";
9586 (match fst style with
9588 pr " Py_INCREF (Py_None);\n";
9589 pr " py_r = Py_None;\n"
9591 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9592 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9593 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9594 | RConstOptString _ ->
9596 pr " py_r = PyString_FromString (r);\n";
9598 pr " Py_INCREF (Py_None);\n";
9599 pr " py_r = Py_None;\n";
9602 pr " py_r = PyString_FromString (r);\n";
9605 pr " py_r = put_string_list (r);\n";
9606 pr " free_strings (r);\n"
9607 | RStruct (_, typ) ->
9608 pr " py_r = put_%s (r);\n" typ;
9609 pr " guestfs_free_%s (r);\n" typ
9610 | RStructList (_, typ) ->
9611 pr " py_r = put_%s_list (r);\n" typ;
9612 pr " guestfs_free_%s_list (r);\n" typ
9614 pr " py_r = put_table (r);\n";
9615 pr " free_strings (r);\n"
9617 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9621 pr " return py_r;\n";
9626 (* Table of functions. *)
9627 pr "static PyMethodDef methods[] = {\n";
9628 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9629 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9631 fun (name, _, _, _, _, _, _) ->
9632 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9635 pr " { NULL, NULL, 0, NULL }\n";
9639 (* Init function. *)
9642 initlibguestfsmod (void)
9644 static int initialized = 0;
9646 if (initialized) return;
9647 Py_InitModule ((char *) \"libguestfsmod\", methods);
9652 (* Generate Python module. *)
9653 and generate_python_py () =
9654 generate_header HashStyle LGPLv2plus;
9657 u\"\"\"Python bindings for libguestfs
9660 g = guestfs.GuestFS ()
9661 g.add_drive (\"guest.img\")
9663 parts = g.list_partitions ()
9665 The guestfs module provides a Python binding to the libguestfs API
9666 for examining and modifying virtual machine disk images.
9668 Amongst the things this is good for: making batch configuration
9669 changes to guests, getting disk used/free statistics (see also:
9670 virt-df), migrating between virtualization systems (see also:
9671 virt-p2v), performing partial backups, performing partial guest
9672 clones, cloning guests and changing registry/UUID/hostname info, and
9675 Libguestfs uses Linux kernel and qemu code, and can access any type of
9676 guest filesystem that Linux and qemu can, including but not limited
9677 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9678 schemes, qcow, qcow2, vmdk.
9680 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9681 LVs, what filesystem is in each LV, etc.). It can also run commands
9682 in the context of the guest. Also you can access filesystems over
9685 Errors which happen while using the API are turned into Python
9686 RuntimeError exceptions.
9688 To create a guestfs handle you usually have to perform the following
9691 # Create the handle, call add_drive at least once, and possibly
9692 # several times if the guest has multiple block devices:
9693 g = guestfs.GuestFS ()
9694 g.add_drive (\"guest.img\")
9696 # Launch the qemu subprocess and wait for it to become ready:
9699 # Now you can issue commands, for example:
9704 import libguestfsmod
9707 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9709 def __init__ (self):
9710 \"\"\"Create a new libguestfs handle.\"\"\"
9711 self._o = libguestfsmod.create ()
9714 libguestfsmod.close (self._o)
9719 fun (name, style, _, flags, _, _, longdesc) ->
9721 generate_py_call_args ~handle:"self" (snd style);
9724 if not (List.mem NotInDocs flags) then (
9725 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9727 match fst style with
9728 | RErr | RInt _ | RInt64 _ | RBool _
9729 | RConstOptString _ | RConstString _
9730 | RString _ | RBufferOut _ -> doc
9732 doc ^ "\n\nThis function returns a list of strings."
9733 | RStruct (_, typ) ->
9734 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9735 | RStructList (_, typ) ->
9736 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9738 doc ^ "\n\nThis function returns a dictionary." in
9740 if List.mem ProtocolLimitWarning flags then
9741 doc ^ "\n\n" ^ protocol_limit_warning
9744 if List.mem DangerWillRobinson flags then
9745 doc ^ "\n\n" ^ danger_will_robinson
9748 match deprecation_notice flags with
9750 | Some txt -> doc ^ "\n\n" ^ txt in
9751 let doc = pod2text ~width:60 name doc in
9752 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9753 let doc = String.concat "\n " doc in
9754 pr " u\"\"\"%s\"\"\"\n" doc;
9756 pr " return libguestfsmod.%s " name;
9757 generate_py_call_args ~handle:"self._o" (snd style);
9762 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9763 and generate_py_call_args ~handle args =
9765 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9768 (* Useful if you need the longdesc POD text as plain text. Returns a
9771 * Because this is very slow (the slowest part of autogeneration),
9772 * we memoize the results.
9774 and pod2text ~width name longdesc =
9775 let key = width, name, longdesc in
9776 try Hashtbl.find pod2text_memo key
9778 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9779 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9781 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9782 let chan = open_process_in cmd in
9783 let lines = ref [] in
9785 let line = input_line chan in
9786 if i = 1 then (* discard the first line of output *)
9789 let line = triml line in
9790 lines := line :: !lines;
9793 let lines = try loop 1 with End_of_file -> List.rev !lines in
9795 (match close_process_in chan with
9798 failwithf "pod2text: process exited with non-zero status (%d)" i
9799 | WSIGNALED i | WSTOPPED i ->
9800 failwithf "pod2text: process signalled or stopped by signal %d" i
9802 Hashtbl.add pod2text_memo key lines;
9803 pod2text_memo_updated ();
9806 (* Generate ruby bindings. *)
9807 and generate_ruby_c () =
9808 generate_header CStyle LGPLv2plus;
9816 #include \"guestfs.h\"
9818 #include \"extconf.h\"
9820 /* For Ruby < 1.9 */
9822 #define RARRAY_LEN(r) (RARRAY((r))->len)
9825 static VALUE m_guestfs; /* guestfs module */
9826 static VALUE c_guestfs; /* guestfs_h handle */
9827 static VALUE e_Error; /* used for all errors */
9829 static void ruby_guestfs_free (void *p)
9832 guestfs_close ((guestfs_h *) p);
9835 static VALUE ruby_guestfs_create (VALUE m)
9839 g = guestfs_create ();
9841 rb_raise (e_Error, \"failed to create guestfs handle\");
9843 /* Don't print error messages to stderr by default. */
9844 guestfs_set_error_handler (g, NULL, NULL);
9846 /* Wrap it, and make sure the close function is called when the
9849 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9852 static VALUE ruby_guestfs_close (VALUE gv)
9855 Data_Get_Struct (gv, guestfs_h, g);
9857 ruby_guestfs_free (g);
9858 DATA_PTR (gv) = NULL;
9866 fun (name, style, _, _, _, _, _) ->
9867 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9868 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9871 pr " guestfs_h *g;\n";
9872 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9874 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9880 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9881 pr " Check_Type (%sv, T_STRING);\n" n;
9882 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9884 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9885 pr " \"%s\", \"%s\");\n" n name
9887 pr " Check_Type (%sv, T_STRING);\n" n;
9888 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
9890 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9891 pr " \"%s\", \"%s\");\n" n name;
9892 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
9894 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9895 | StringList n | DeviceList n ->
9896 pr " char **%s;\n" n;
9897 pr " Check_Type (%sv, T_ARRAY);\n" n;
9899 pr " int i, len;\n";
9900 pr " len = RARRAY_LEN (%sv);\n" n;
9901 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9903 pr " for (i = 0; i < len; ++i) {\n";
9904 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9905 pr " %s[i] = StringValueCStr (v);\n" n;
9907 pr " %s[len] = NULL;\n" n;
9910 pr " int %s = RTEST (%sv);\n" n n
9912 pr " int %s = NUM2INT (%sv);\n" n n
9914 pr " long long %s = NUM2LL (%sv);\n" n n
9919 match fst style with
9920 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9921 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9922 | RConstString _ | RConstOptString _ ->
9923 pr " const char *r;\n"; "NULL"
9924 | RString _ -> pr " char *r;\n"; "NULL"
9925 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9926 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9927 | RStructList (_, typ) ->
9928 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9931 pr " size_t size;\n";
9935 pr " r = guestfs_%s " name;
9936 generate_c_call_args ~handle:"g" style;
9941 | Pathname _ | Device _ | Dev_or_Path _ | String _
9942 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9944 | StringList n | DeviceList n ->
9945 pr " free (%s);\n" n
9948 pr " if (r == %s)\n" error_code;
9949 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9952 (match fst style with
9954 pr " return Qnil;\n"
9955 | RInt _ | RBool _ ->
9956 pr " return INT2NUM (r);\n"
9958 pr " return ULL2NUM (r);\n"
9960 pr " return rb_str_new2 (r);\n";
9961 | RConstOptString _ ->
9963 pr " return rb_str_new2 (r);\n";
9965 pr " return Qnil;\n";
9967 pr " VALUE rv = rb_str_new2 (r);\n";
9971 pr " int i, len = 0;\n";
9972 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9973 pr " VALUE rv = rb_ary_new2 (len);\n";
9974 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9975 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9976 pr " free (r[i]);\n";
9980 | RStruct (_, typ) ->
9981 let cols = cols_of_struct typ in
9982 generate_ruby_struct_code typ cols
9983 | RStructList (_, typ) ->
9984 let cols = cols_of_struct typ in
9985 generate_ruby_struct_list_code typ cols
9987 pr " VALUE rv = rb_hash_new ();\n";
9989 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9990 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9991 pr " free (r[i]);\n";
9992 pr " free (r[i+1]);\n";
9997 pr " VALUE rv = rb_str_new (r, size);\n";
10007 /* Initialize the module. */
10008 void Init__guestfs ()
10010 m_guestfs = rb_define_module (\"Guestfs\");
10011 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
10012 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
10014 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
10015 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
10018 (* Define the rest of the methods. *)
10020 fun (name, style, _, _, _, _, _) ->
10021 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
10022 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
10027 (* Ruby code to return a struct. *)
10028 and generate_ruby_struct_code typ cols =
10029 pr " VALUE rv = rb_hash_new ();\n";
10033 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
10035 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
10037 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
10038 | name, (FBytes|FUInt64) ->
10039 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10041 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
10043 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
10045 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
10046 | name, FOptPercent ->
10047 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
10048 | name, FChar -> (* XXX wrong? *)
10049 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10051 pr " guestfs_free_%s (r);\n" typ;
10054 (* Ruby code to return a struct list. *)
10055 and generate_ruby_struct_list_code typ cols =
10056 pr " VALUE rv = rb_ary_new2 (r->len);\n";
10058 pr " for (i = 0; i < r->len; ++i) {\n";
10059 pr " VALUE hv = rb_hash_new ();\n";
10063 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
10065 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
10067 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
10068 | name, (FBytes|FUInt64) ->
10069 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10071 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
10073 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
10075 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
10076 | name, FOptPercent ->
10077 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
10078 | name, FChar -> (* XXX wrong? *)
10079 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10081 pr " rb_ary_push (rv, hv);\n";
10083 pr " guestfs_free_%s_list (r);\n" typ;
10086 (* Generate Java bindings GuestFS.java file. *)
10087 and generate_java_java () =
10088 generate_header CStyle LGPLv2plus;
10091 package com.redhat.et.libguestfs;
10093 import java.util.HashMap;
10094 import com.redhat.et.libguestfs.LibGuestFSException;
10095 import com.redhat.et.libguestfs.PV;
10096 import com.redhat.et.libguestfs.VG;
10097 import com.redhat.et.libguestfs.LV;
10098 import com.redhat.et.libguestfs.Stat;
10099 import com.redhat.et.libguestfs.StatVFS;
10100 import com.redhat.et.libguestfs.IntBool;
10101 import com.redhat.et.libguestfs.Dirent;
10104 * The GuestFS object is a libguestfs handle.
10108 public class GuestFS {
10109 // Load the native code.
10111 System.loadLibrary (\"guestfs_jni\");
10115 * The native guestfs_h pointer.
10120 * Create a libguestfs handle.
10122 * @throws LibGuestFSException
10124 public GuestFS () throws LibGuestFSException
10128 private native long _create () throws LibGuestFSException;
10131 * Close a libguestfs handle.
10133 * You can also leave handles to be collected by the garbage
10134 * collector, but this method ensures that the resources used
10135 * by the handle are freed up immediately. If you call any
10136 * other methods after closing the handle, you will get an
10139 * @throws LibGuestFSException
10141 public void close () throws LibGuestFSException
10147 private native void _close (long g) throws LibGuestFSException;
10149 public void finalize () throws LibGuestFSException
10157 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10158 if not (List.mem NotInDocs flags); then (
10159 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10161 if List.mem ProtocolLimitWarning flags then
10162 doc ^ "\n\n" ^ protocol_limit_warning
10165 if List.mem DangerWillRobinson flags then
10166 doc ^ "\n\n" ^ danger_will_robinson
10169 match deprecation_notice flags with
10171 | Some txt -> doc ^ "\n\n" ^ txt in
10172 let doc = pod2text ~width:60 name doc in
10173 let doc = List.map ( (* RHBZ#501883 *)
10176 | nonempty -> nonempty
10178 let doc = String.concat "\n * " doc in
10181 pr " * %s\n" shortdesc;
10184 pr " * @throws LibGuestFSException\n";
10188 generate_java_prototype ~public:true ~semicolon:false name style;
10191 pr " if (g == 0)\n";
10192 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10195 if fst style <> RErr then pr "return ";
10197 generate_java_call_args ~handle:"g" (snd style);
10201 generate_java_prototype ~privat:true ~native:true name style;
10208 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10209 and generate_java_call_args ~handle args =
10211 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10214 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10215 ?(semicolon=true) name style =
10216 if privat then pr "private ";
10217 if public then pr "public ";
10218 if native then pr "native ";
10221 (match fst style with
10222 | RErr -> pr "void ";
10223 | RInt _ -> pr "int ";
10224 | RInt64 _ -> pr "long ";
10225 | RBool _ -> pr "boolean ";
10226 | RConstString _ | RConstOptString _ | RString _
10227 | RBufferOut _ -> pr "String ";
10228 | RStringList _ -> pr "String[] ";
10229 | RStruct (_, typ) ->
10230 let name = java_name_of_struct typ in
10232 | RStructList (_, typ) ->
10233 let name = java_name_of_struct typ in
10235 | RHashtable _ -> pr "HashMap<String,String> ";
10238 if native then pr "_%s " name else pr "%s " name;
10240 let needs_comma = ref false in
10243 needs_comma := true
10249 if !needs_comma then pr ", ";
10250 needs_comma := true;
10254 | Device n | Dev_or_Path n
10262 | StringList n | DeviceList n ->
10273 pr " throws LibGuestFSException";
10274 if semicolon then pr ";"
10276 and generate_java_struct jtyp cols () =
10277 generate_header CStyle LGPLv2plus;
10280 package com.redhat.et.libguestfs;
10283 * Libguestfs %s structure.
10295 | name, FBuffer -> pr " public String %s;\n" name
10296 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10297 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10298 | name, FChar -> pr " public char %s;\n" name
10299 | name, FOptPercent ->
10300 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10301 pr " public float %s;\n" name
10306 and generate_java_c () =
10307 generate_header CStyle LGPLv2plus;
10311 #include <stdlib.h>
10312 #include <string.h>
10314 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10315 #include \"guestfs.h\"
10317 /* Note that this function returns. The exception is not thrown
10318 * until after the wrapper function returns.
10321 throw_exception (JNIEnv *env, const char *msg)
10324 cl = (*env)->FindClass (env,
10325 \"com/redhat/et/libguestfs/LibGuestFSException\");
10326 (*env)->ThrowNew (env, cl, msg);
10329 JNIEXPORT jlong JNICALL
10330 Java_com_redhat_et_libguestfs_GuestFS__1create
10331 (JNIEnv *env, jobject obj)
10335 g = guestfs_create ();
10337 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10340 guestfs_set_error_handler (g, NULL, NULL);
10341 return (jlong) (long) g;
10344 JNIEXPORT void JNICALL
10345 Java_com_redhat_et_libguestfs_GuestFS__1close
10346 (JNIEnv *env, jobject obj, jlong jg)
10348 guestfs_h *g = (guestfs_h *) (long) jg;
10355 fun (name, style, _, _, _, _, _) ->
10357 (match fst style with
10358 | RErr -> pr "void ";
10359 | RInt _ -> pr "jint ";
10360 | RInt64 _ -> pr "jlong ";
10361 | RBool _ -> pr "jboolean ";
10362 | RConstString _ | RConstOptString _ | RString _
10363 | RBufferOut _ -> pr "jstring ";
10364 | RStruct _ | RHashtable _ ->
10366 | RStringList _ | RStructList _ ->
10367 pr "jobjectArray ";
10370 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10371 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10373 pr " (JNIEnv *env, jobject obj, jlong jg";
10377 | Device n | Dev_or_Path n
10382 pr ", jstring j%s" n
10384 pr ", jbyteArray j%s" n
10385 | StringList n | DeviceList n ->
10386 pr ", jobjectArray j%s" n
10388 pr ", jboolean j%s" n
10396 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10397 let error_code, no_ret =
10398 match fst style with
10399 | RErr -> pr " int r;\n"; "-1", ""
10401 | RInt _ -> pr " int r;\n"; "-1", "0"
10402 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10403 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10404 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10406 pr " jstring jr;\n";
10407 pr " char *r;\n"; "NULL", "NULL"
10409 pr " jobjectArray jr;\n";
10410 pr " int r_len;\n";
10411 pr " jclass cl;\n";
10412 pr " jstring jstr;\n";
10413 pr " char **r;\n"; "NULL", "NULL"
10414 | RStruct (_, typ) ->
10415 pr " jobject jr;\n";
10416 pr " jclass cl;\n";
10417 pr " jfieldID fl;\n";
10418 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10419 | RStructList (_, typ) ->
10420 pr " jobjectArray jr;\n";
10421 pr " jclass cl;\n";
10422 pr " jfieldID fl;\n";
10423 pr " jobject jfl;\n";
10424 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10425 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10427 pr " jstring jr;\n";
10429 pr " size_t size;\n";
10434 | Device n | Dev_or_Path n
10439 pr " const char *%s;\n" n
10441 pr " jbyte *%s;\n" n;
10442 pr " size_t %s_size;\n" n
10443 | StringList n | DeviceList n ->
10444 pr " int %s_len;\n" n;
10445 pr " const char **%s;\n" n
10450 pr " int64_t %s;\n" n
10454 (match fst style with
10455 | RStringList _ | RStructList _ -> true
10456 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10457 | RConstOptString _
10458 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10459 List.exists (function
10460 | StringList _ -> true
10461 | DeviceList _ -> true
10462 | _ -> false) (snd style) in
10468 (* Get the parameters. *)
10472 | Device n | Dev_or_Path n
10476 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10478 (* This is completely undocumented, but Java null becomes
10479 * a NULL parameter.
10481 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10483 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10484 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10485 | StringList n | DeviceList n ->
10486 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10487 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10488 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10489 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10491 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10493 pr " %s[%s_len] = NULL;\n" n n;
10497 pr " %s = j%s;\n" n n
10500 (* Make the call. *)
10501 pr " r = guestfs_%s " name;
10502 generate_c_call_args ~handle:"g" style;
10505 (* Release the parameters. *)
10509 | Device n | Dev_or_Path n
10513 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10515 pr " if (j%s)\n" n;
10516 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10518 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10519 | StringList n | DeviceList n ->
10520 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10521 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10523 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10525 pr " free (%s);\n" n
10531 (* Check for errors. *)
10532 pr " if (r == %s) {\n" error_code;
10533 pr " throw_exception (env, guestfs_last_error (g));\n";
10534 pr " return %s;\n" no_ret;
10537 (* Return value. *)
10538 (match fst style with
10540 | RInt _ -> pr " return (jint) r;\n"
10541 | RBool _ -> pr " return (jboolean) r;\n"
10542 | RInt64 _ -> pr " return (jlong) r;\n"
10543 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10544 | RConstOptString _ ->
10545 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10547 pr " jr = (*env)->NewStringUTF (env, r);\n";
10551 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10552 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10553 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10554 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10555 pr " for (i = 0; i < r_len; ++i) {\n";
10556 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10557 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10558 pr " free (r[i]);\n";
10562 | RStruct (_, typ) ->
10563 let jtyp = java_name_of_struct typ in
10564 let cols = cols_of_struct typ in
10565 generate_java_struct_return typ jtyp cols
10566 | RStructList (_, typ) ->
10567 let jtyp = java_name_of_struct typ in
10568 let cols = cols_of_struct typ in
10569 generate_java_struct_list_return typ jtyp cols
10572 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10573 pr " return NULL;\n"
10575 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10584 and generate_java_struct_return typ jtyp cols =
10585 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10586 pr " jr = (*env)->AllocObject (env, cl);\n";
10590 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10591 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10594 pr " char s[33];\n";
10595 pr " memcpy (s, r->%s, 32);\n" name;
10596 pr " s[32] = 0;\n";
10597 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10598 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10602 pr " int len = r->%s_len;\n" name;
10603 pr " char s[len+1];\n";
10604 pr " memcpy (s, r->%s, len);\n" name;
10605 pr " s[len] = 0;\n";
10606 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10607 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10609 | name, (FBytes|FUInt64|FInt64) ->
10610 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10611 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10612 | name, (FUInt32|FInt32) ->
10613 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10614 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10615 | name, FOptPercent ->
10616 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10617 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10619 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10620 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10625 and generate_java_struct_list_return typ jtyp cols =
10626 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10627 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10628 pr " for (i = 0; i < r->len; ++i) {\n";
10629 pr " jfl = (*env)->AllocObject (env, cl);\n";
10633 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10634 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10637 pr " char s[33];\n";
10638 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10639 pr " s[32] = 0;\n";
10640 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10641 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10645 pr " int len = r->val[i].%s_len;\n" name;
10646 pr " char s[len+1];\n";
10647 pr " memcpy (s, r->val[i].%s, len);\n" name;
10648 pr " s[len] = 0;\n";
10649 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10650 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10652 | name, (FBytes|FUInt64|FInt64) ->
10653 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10654 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10655 | name, (FUInt32|FInt32) ->
10656 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10657 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10658 | name, FOptPercent ->
10659 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10660 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10662 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10663 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10665 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10667 pr " guestfs_free_%s_list (r);\n" typ;
10670 and generate_java_makefile_inc () =
10671 generate_header HashStyle GPLv2plus;
10673 pr "java_built_sources = \\\n";
10676 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10678 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10680 and generate_haskell_hs () =
10681 generate_header HaskellStyle LGPLv2plus;
10683 (* XXX We only know how to generate partial FFI for Haskell
10684 * at the moment. Please help out!
10686 let can_generate style =
10690 | RInt64 _, _ -> true
10692 | RConstString _, _
10693 | RConstOptString _, _
10699 | RBufferOut _, _ -> false in
10702 {-# INCLUDE <guestfs.h> #-}
10703 {-# LANGUAGE ForeignFunctionInterface #-}
10708 (* List out the names of the actions we want to export. *)
10710 fun (name, style, _, _, _, _, _) ->
10711 if can_generate style then pr ",\n %s" name
10717 -- Unfortunately some symbols duplicate ones already present
10718 -- in Prelude. We don't know which, so we hard-code a list
10720 import Prelude hiding (truncate)
10724 import Foreign.C.Types
10726 import Control.Exception
10727 import Data.Typeable
10729 data GuestfsS = GuestfsS -- represents the opaque C struct
10730 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10731 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10733 -- XXX define properly later XXX
10737 data IntBool = IntBool
10739 data StatVFS = StatVFS
10740 data Hashtable = Hashtable
10742 foreign import ccall unsafe \"guestfs_create\" c_create
10744 foreign import ccall unsafe \"&guestfs_close\" c_close
10745 :: FunPtr (GuestfsP -> IO ())
10746 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10747 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10749 create :: IO GuestfsH
10752 c_set_error_handler p nullPtr nullPtr
10753 h <- newForeignPtr c_close p
10756 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10757 :: GuestfsP -> IO CString
10759 -- last_error :: GuestfsH -> IO (Maybe String)
10760 -- last_error h = do
10761 -- str <- withForeignPtr h (\\p -> c_last_error p)
10762 -- maybePeek peekCString str
10764 last_error :: GuestfsH -> IO (String)
10766 str <- withForeignPtr h (\\p -> c_last_error p)
10767 if (str == nullPtr)
10768 then return \"no error\"
10769 else peekCString str
10773 (* Generate wrappers for each foreign function. *)
10775 fun (name, style, _, _, _, _, _) ->
10776 if can_generate style then (
10777 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10779 generate_haskell_prototype ~handle:"GuestfsP" style;
10783 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10785 pr "%s %s = do\n" name
10786 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10788 (* Convert pointer arguments using with* functions. *)
10793 | Pathname n | Device n | Dev_or_Path n | String n ->
10794 pr "withCString %s $ \\%s -> " n n
10796 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10797 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10798 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10799 | Bool _ | Int _ | Int64 _ -> ()
10801 (* Convert integer arguments. *)
10805 | Bool n -> sprintf "(fromBool %s)" n
10806 | Int n -> sprintf "(fromIntegral %s)" n
10807 | Int64 n -> sprintf "(fromIntegral %s)" n
10808 | FileIn n | FileOut n
10809 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10810 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
10812 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10813 (String.concat " " ("p" :: args));
10814 (match fst style with
10815 | RErr | RInt _ | RInt64 _ | RBool _ ->
10816 pr " if (r == -1)\n";
10818 pr " err <- last_error h\n";
10820 | RConstString _ | RConstOptString _ | RString _
10821 | RStringList _ | RStruct _
10822 | RStructList _ | RHashtable _ | RBufferOut _ ->
10823 pr " if (r == nullPtr)\n";
10825 pr " err <- last_error h\n";
10828 (match fst style with
10830 pr " else return ()\n"
10832 pr " else return (fromIntegral r)\n"
10834 pr " else return (fromIntegral r)\n"
10836 pr " else return (toBool r)\n"
10838 | RConstOptString _
10845 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10851 and generate_haskell_prototype ~handle ?(hs = false) style =
10852 pr "%s -> " handle;
10853 let string = if hs then "String" else "CString" in
10854 let int = if hs then "Int" else "CInt" in
10855 let bool = if hs then "Bool" else "CInt" in
10856 let int64 = if hs then "Integer" else "Int64" in
10860 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10862 if hs then pr "String"
10863 else pr "CString -> CInt"
10864 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10865 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10866 | Bool _ -> pr "%s" bool
10867 | Int _ -> pr "%s" int
10868 | Int64 _ -> pr "%s" int
10869 | FileIn _ -> pr "%s" string
10870 | FileOut _ -> pr "%s" string
10875 (match fst style with
10876 | RErr -> if not hs then pr "CInt"
10877 | RInt _ -> pr "%s" int
10878 | RInt64 _ -> pr "%s" int64
10879 | RBool _ -> pr "%s" bool
10880 | RConstString _ -> pr "%s" string
10881 | RConstOptString _ -> pr "Maybe %s" string
10882 | RString _ -> pr "%s" string
10883 | RStringList _ -> pr "[%s]" string
10884 | RStruct (_, typ) ->
10885 let name = java_name_of_struct typ in
10887 | RStructList (_, typ) ->
10888 let name = java_name_of_struct typ in
10890 | RHashtable _ -> pr "Hashtable"
10891 | RBufferOut _ -> pr "%s" string
10895 and generate_csharp () =
10896 generate_header CPlusPlusStyle LGPLv2plus;
10898 (* XXX Make this configurable by the C# assembly users. *)
10899 let library = "libguestfs.so.0" in
10902 // These C# bindings are highly experimental at present.
10904 // Firstly they only work on Linux (ie. Mono). In order to get them
10905 // to work on Windows (ie. .Net) you would need to port the library
10906 // itself to Windows first.
10908 // The second issue is that some calls are known to be incorrect and
10909 // can cause Mono to segfault. Particularly: calls which pass or
10910 // return string[], or return any structure value. This is because
10911 // we haven't worked out the correct way to do this from C#.
10913 // The third issue is that when compiling you get a lot of warnings.
10914 // We are not sure whether the warnings are important or not.
10916 // Fourthly we do not routinely build or test these bindings as part
10917 // of the make && make check cycle, which means that regressions might
10920 // Suggestions and patches are welcome.
10924 // gmcs Libguestfs.cs
10925 // mono Libguestfs.exe
10927 // (You'll probably want to add a Test class / static main function
10928 // otherwise this won't do anything useful).
10932 using System.Runtime.InteropServices;
10933 using System.Runtime.Serialization;
10934 using System.Collections;
10938 class Error : System.ApplicationException
10940 public Error (string message) : base (message) {}
10941 protected Error (SerializationInfo info, StreamingContext context) {}
10948 [DllImport (\"%s\")]
10949 static extern IntPtr guestfs_create ();
10953 _handle = guestfs_create ();
10954 if (_handle == IntPtr.Zero)
10955 throw new Error (\"could not create guestfs handle\");
10958 [DllImport (\"%s\")]
10959 static extern void guestfs_close (IntPtr h);
10963 guestfs_close (_handle);
10966 [DllImport (\"%s\")]
10967 static extern string guestfs_last_error (IntPtr h);
10969 " library library library;
10971 (* Generate C# structure bindings. We prefix struct names with
10972 * underscore because C# cannot have conflicting struct names and
10973 * method names (eg. "class stat" and "stat").
10977 pr " [StructLayout (LayoutKind.Sequential)]\n";
10978 pr " public class _%s {\n" typ;
10981 | name, FChar -> pr " char %s;\n" name
10982 | name, FString -> pr " string %s;\n" name
10984 pr " uint %s_len;\n" name;
10985 pr " string %s;\n" name
10987 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10988 pr " string %s;\n" name
10989 | name, FUInt32 -> pr " uint %s;\n" name
10990 | name, FInt32 -> pr " int %s;\n" name
10991 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10992 | name, FInt64 -> pr " long %s;\n" name
10993 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10999 (* Generate C# function bindings. *)
11001 fun (name, style, _, _, _, shortdesc, _) ->
11002 let rec csharp_return_type () =
11003 match fst style with
11005 | RBool n -> "bool"
11007 | RInt64 n -> "long"
11009 | RConstOptString n
11011 | RBufferOut n -> "string"
11012 | RStruct (_,n) -> "_" ^ n
11013 | RHashtable n -> "Hashtable"
11014 | RStringList n -> "string[]"
11015 | RStructList (_,n) -> sprintf "_%s[]" n
11017 and c_return_type () =
11018 match fst style with
11022 | RInt64 _ -> "long"
11024 | RConstOptString _
11026 | RBufferOut _ -> "string"
11027 | RStruct (_,n) -> "_" ^ n
11029 | RStringList _ -> "string[]"
11030 | RStructList (_,n) -> sprintf "_%s[]" n
11032 and c_error_comparison () =
11033 match fst style with
11037 | RInt64 _ -> "== -1"
11039 | RConstOptString _
11045 | RStructList (_,_) -> "== null"
11047 and generate_extern_prototype () =
11048 pr " static extern %s guestfs_%s (IntPtr h"
11049 (c_return_type ()) name;
11052 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11053 | FileIn n | FileOut n
11055 pr ", [In] string %s" n
11056 | StringList n | DeviceList n ->
11057 pr ", [In] string[] %s" n
11067 and generate_public_prototype () =
11068 pr " public %s %s (" (csharp_return_type ()) name;
11069 let comma = ref false in
11071 if !comma then pr ", ";
11076 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11077 | FileIn n | FileOut n
11079 next (); pr "string %s" n
11080 | StringList n | DeviceList n ->
11081 next (); pr "string[] %s" n
11083 next (); pr "bool %s" n
11085 next (); pr "int %s" n
11087 next (); pr "long %s" n
11091 and generate_call () =
11092 pr "guestfs_%s (_handle" name;
11093 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
11097 pr " [DllImport (\"%s\")]\n" library;
11098 generate_extern_prototype ();
11100 pr " /// <summary>\n";
11101 pr " /// %s\n" shortdesc;
11102 pr " /// </summary>\n";
11103 generate_public_prototype ();
11105 pr " %s r;\n" (c_return_type ());
11108 pr " if (r %s)\n" (c_error_comparison ());
11109 pr " throw new Error (guestfs_last_error (_handle));\n";
11110 (match fst style with
11113 pr " return r != 0 ? true : false;\n"
11115 pr " Hashtable rr = new Hashtable ();\n";
11116 pr " for (int i = 0; i < r.Length; i += 2)\n";
11117 pr " rr.Add (r[i], r[i+1]);\n";
11119 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
11120 | RString _ | RBufferOut _ | RStruct _ | RStringList _
11126 ) all_functions_sorted;
11132 and generate_bindtests () =
11133 generate_header CStyle LGPLv2plus;
11137 #include <stdlib.h>
11138 #include <inttypes.h>
11139 #include <string.h>
11141 #include \"guestfs.h\"
11142 #include \"guestfs-internal.h\"
11143 #include \"guestfs-internal-actions.h\"
11144 #include \"guestfs_protocol.h\"
11146 #define error guestfs_error
11147 #define safe_calloc guestfs_safe_calloc
11148 #define safe_malloc guestfs_safe_malloc
11151 print_strings (char *const *argv)
11156 for (argc = 0; argv[argc] != NULL; ++argc) {
11157 if (argc > 0) printf (\", \");
11158 printf (\"\\\"%%s\\\"\", argv[argc]);
11163 /* The test0 function prints its parameters to stdout. */
11167 match test_functions with
11168 | [] -> assert false
11169 | test0 :: tests -> test0, tests in
11172 let (name, style, _, _, _, _, _) = test0 in
11173 generate_prototype ~extern:false ~semicolon:false ~newline:true
11174 ~handle:"g" ~prefix:"guestfs__" name style;
11179 | Device n | Dev_or_Path n
11182 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
11186 pr " for (i = 0; i < %s_size; ++i)\n" n;
11187 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11188 pr " printf (\"\\n\");\n";
11190 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11191 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11192 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11193 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11194 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11196 pr " /* Java changes stdout line buffering so we need this: */\n";
11197 pr " fflush (stdout);\n";
11203 fun (name, style, _, _, _, _, _) ->
11204 if String.sub name (String.length name - 3) 3 <> "err" then (
11205 pr "/* Test normal return. */\n";
11206 generate_prototype ~extern:false ~semicolon:false ~newline:true
11207 ~handle:"g" ~prefix:"guestfs__" name style;
11209 (match fst style with
11214 pr " sscanf (val, \"%%d\", &r);\n";
11217 pr " int64_t r;\n";
11218 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11221 pr " return STREQ (val, \"true\");\n"
11223 | RConstOptString _ ->
11224 (* Can't return the input string here. Return a static
11225 * string so we ensure we get a segfault if the caller
11226 * tries to free it.
11228 pr " return \"static string\";\n"
11230 pr " return strdup (val);\n"
11232 pr " char **strs;\n";
11234 pr " sscanf (val, \"%%d\", &n);\n";
11235 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11236 pr " for (i = 0; i < n; ++i) {\n";
11237 pr " strs[i] = safe_malloc (g, 16);\n";
11238 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11240 pr " strs[n] = NULL;\n";
11241 pr " return strs;\n"
11242 | RStruct (_, typ) ->
11243 pr " struct guestfs_%s *r;\n" typ;
11244 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11246 | RStructList (_, typ) ->
11247 pr " struct guestfs_%s_list *r;\n" typ;
11248 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11249 pr " sscanf (val, \"%%d\", &r->len);\n";
11250 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11253 pr " char **strs;\n";
11255 pr " sscanf (val, \"%%d\", &n);\n";
11256 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11257 pr " for (i = 0; i < n; ++i) {\n";
11258 pr " strs[i*2] = safe_malloc (g, 16);\n";
11259 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11260 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11261 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11263 pr " strs[n*2] = NULL;\n";
11264 pr " return strs;\n"
11266 pr " return strdup (val);\n"
11271 pr "/* Test error return. */\n";
11272 generate_prototype ~extern:false ~semicolon:false ~newline:true
11273 ~handle:"g" ~prefix:"guestfs__" name style;
11275 pr " error (g, \"error\");\n";
11276 (match fst style with
11277 | RErr | RInt _ | RInt64 _ | RBool _ ->
11279 | RConstString _ | RConstOptString _
11280 | RString _ | RStringList _ | RStruct _
11284 pr " return NULL;\n"
11291 and generate_ocaml_bindtests () =
11292 generate_header OCamlStyle GPLv2plus;
11296 let g = Guestfs.create () in
11300 String.concat " " (
11303 | CallString s -> "\"" ^ s ^ "\""
11304 | CallOptString None -> "None"
11305 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11306 | CallStringList xs ->
11307 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11308 | CallInt i when i >= 0 -> string_of_int i
11309 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11310 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11311 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11312 | CallBool b -> string_of_bool b
11313 | CallBuffer s -> sprintf "%S" s
11318 generate_lang_bindtests (
11319 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11322 pr "print_endline \"EOF\"\n"
11324 and generate_perl_bindtests () =
11325 pr "#!/usr/bin/perl -w\n";
11326 generate_header HashStyle GPLv2plus;
11333 my $g = Sys::Guestfs->new ();
11337 String.concat ", " (
11340 | CallString s -> "\"" ^ s ^ "\""
11341 | CallOptString None -> "undef"
11342 | CallOptString (Some s) -> sprintf "\"%s\"" s
11343 | CallStringList xs ->
11344 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11345 | CallInt i -> string_of_int i
11346 | CallInt64 i -> Int64.to_string i
11347 | CallBool b -> if b then "1" else "0"
11348 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11353 generate_lang_bindtests (
11354 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11357 pr "print \"EOF\\n\"\n"
11359 and generate_python_bindtests () =
11360 generate_header HashStyle GPLv2plus;
11365 g = guestfs.GuestFS ()
11369 String.concat ", " (
11372 | CallString s -> "\"" ^ s ^ "\""
11373 | CallOptString None -> "None"
11374 | CallOptString (Some s) -> sprintf "\"%s\"" s
11375 | CallStringList xs ->
11376 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11377 | CallInt i -> string_of_int i
11378 | CallInt64 i -> Int64.to_string i
11379 | CallBool b -> if b then "1" else "0"
11380 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11385 generate_lang_bindtests (
11386 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11389 pr "print \"EOF\"\n"
11391 and generate_ruby_bindtests () =
11392 generate_header HashStyle GPLv2plus;
11397 g = Guestfs::create()
11401 String.concat ", " (
11404 | CallString s -> "\"" ^ s ^ "\""
11405 | CallOptString None -> "nil"
11406 | CallOptString (Some s) -> sprintf "\"%s\"" s
11407 | CallStringList xs ->
11408 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11409 | CallInt i -> string_of_int i
11410 | CallInt64 i -> Int64.to_string i
11411 | CallBool b -> string_of_bool b
11412 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11417 generate_lang_bindtests (
11418 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11421 pr "print \"EOF\\n\"\n"
11423 and generate_java_bindtests () =
11424 generate_header CStyle GPLv2plus;
11427 import com.redhat.et.libguestfs.*;
11429 public class Bindtests {
11430 public static void main (String[] argv)
11433 GuestFS g = new GuestFS ();
11437 String.concat ", " (
11440 | CallString s -> "\"" ^ s ^ "\""
11441 | CallOptString None -> "null"
11442 | CallOptString (Some s) -> sprintf "\"%s\"" s
11443 | CallStringList xs ->
11445 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11446 | CallInt i -> string_of_int i
11447 | CallInt64 i -> Int64.to_string i
11448 | CallBool b -> string_of_bool b
11450 "new byte[] { " ^ String.concat "," (
11451 map_chars (fun c -> string_of_int (Char.code c)) s
11457 generate_lang_bindtests (
11458 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11462 System.out.println (\"EOF\");
11464 catch (Exception exn) {
11465 System.err.println (exn);
11472 and generate_haskell_bindtests () =
11473 generate_header HaskellStyle GPLv2plus;
11476 module Bindtests where
11477 import qualified Guestfs
11480 g <- Guestfs.create
11484 String.concat " " (
11487 | CallString s -> "\"" ^ s ^ "\""
11488 | CallOptString None -> "Nothing"
11489 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11490 | CallStringList xs ->
11491 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11492 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11493 | CallInt i -> string_of_int i
11494 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11495 | CallInt64 i -> Int64.to_string i
11496 | CallBool true -> "True"
11497 | CallBool false -> "False"
11498 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11503 generate_lang_bindtests (
11504 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11507 pr " putStrLn \"EOF\"\n"
11509 (* Language-independent bindings tests - we do it this way to
11510 * ensure there is parity in testing bindings across all languages.
11512 and generate_lang_bindtests call =
11513 call "test0" [CallString "abc"; CallOptString (Some "def");
11514 CallStringList []; CallBool false;
11515 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11516 CallBuffer "abc\000abc"];
11517 call "test0" [CallString "abc"; CallOptString None;
11518 CallStringList []; CallBool false;
11519 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11520 CallBuffer "abc\000abc"];
11521 call "test0" [CallString ""; CallOptString (Some "def");
11522 CallStringList []; CallBool false;
11523 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11524 CallBuffer "abc\000abc"];
11525 call "test0" [CallString ""; CallOptString (Some "");
11526 CallStringList []; CallBool false;
11527 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11528 CallBuffer "abc\000abc"];
11529 call "test0" [CallString "abc"; CallOptString (Some "def");
11530 CallStringList ["1"]; CallBool false;
11531 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11532 CallBuffer "abc\000abc"];
11533 call "test0" [CallString "abc"; CallOptString (Some "def");
11534 CallStringList ["1"; "2"]; CallBool false;
11535 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11536 CallBuffer "abc\000abc"];
11537 call "test0" [CallString "abc"; CallOptString (Some "def");
11538 CallStringList ["1"]; CallBool true;
11539 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11540 CallBuffer "abc\000abc"];
11541 call "test0" [CallString "abc"; CallOptString (Some "def");
11542 CallStringList ["1"]; CallBool false;
11543 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11544 CallBuffer "abc\000abc"];
11545 call "test0" [CallString "abc"; CallOptString (Some "def");
11546 CallStringList ["1"]; CallBool false;
11547 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11548 CallBuffer "abc\000abc"];
11549 call "test0" [CallString "abc"; CallOptString (Some "def");
11550 CallStringList ["1"]; CallBool false;
11551 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11552 CallBuffer "abc\000abc"];
11553 call "test0" [CallString "abc"; CallOptString (Some "def");
11554 CallStringList ["1"]; CallBool false;
11555 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11556 CallBuffer "abc\000abc"];
11557 call "test0" [CallString "abc"; CallOptString (Some "def");
11558 CallStringList ["1"]; CallBool false;
11559 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11560 CallBuffer "abc\000abc"];
11561 call "test0" [CallString "abc"; CallOptString (Some "def");
11562 CallStringList ["1"]; CallBool false;
11563 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11564 CallBuffer "abc\000abc"]
11566 (* XXX Add here tests of the return and error functions. *)
11568 (* Code to generator bindings for virt-inspector. Currently only
11569 * implemented for OCaml code (for virt-p2v 2.0).
11571 let rng_input = "inspector/virt-inspector.rng"
11573 (* Read the input file and parse it into internal structures. This is
11574 * by no means a complete RELAX NG parser, but is just enough to be
11575 * able to parse the specific input file.
11578 | Element of string * rng list (* <element name=name/> *)
11579 | Attribute of string * rng list (* <attribute name=name/> *)
11580 | Interleave of rng list (* <interleave/> *)
11581 | ZeroOrMore of rng (* <zeroOrMore/> *)
11582 | OneOrMore of rng (* <oneOrMore/> *)
11583 | Optional of rng (* <optional/> *)
11584 | Choice of string list (* <choice><value/>*</choice> *)
11585 | Value of string (* <value>str</value> *)
11586 | Text (* <text/> *)
11588 let rec string_of_rng = function
11589 | Element (name, xs) ->
11590 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11591 | Attribute (name, xs) ->
11592 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11593 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11594 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11595 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11596 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11597 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11598 | Value value -> "Value \"" ^ value ^ "\""
11601 and string_of_rng_list xs =
11602 String.concat ", " (List.map string_of_rng xs)
11604 let rec parse_rng ?defines context = function
11606 | Xml.Element ("element", ["name", name], children) :: rest ->
11607 Element (name, parse_rng ?defines context children)
11608 :: parse_rng ?defines context rest
11609 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11610 Attribute (name, parse_rng ?defines context children)
11611 :: parse_rng ?defines context rest
11612 | Xml.Element ("interleave", [], children) :: rest ->
11613 Interleave (parse_rng ?defines context children)
11614 :: parse_rng ?defines context rest
11615 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11616 let rng = parse_rng ?defines context [child] in
11618 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11620 failwithf "%s: <zeroOrMore> contains more than one child element"
11623 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11624 let rng = parse_rng ?defines context [child] in
11626 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11628 failwithf "%s: <oneOrMore> contains more than one child element"
11631 | Xml.Element ("optional", [], [child]) :: rest ->
11632 let rng = parse_rng ?defines context [child] in
11634 | [child] -> Optional child :: parse_rng ?defines context rest
11636 failwithf "%s: <optional> contains more than one child element"
11639 | Xml.Element ("choice", [], children) :: rest ->
11640 let values = List.map (
11641 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11643 failwithf "%s: can't handle anything except <value> in <choice>"
11647 :: parse_rng ?defines context rest
11648 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11649 Value value :: parse_rng ?defines context rest
11650 | Xml.Element ("text", [], []) :: rest ->
11651 Text :: parse_rng ?defines context rest
11652 | Xml.Element ("ref", ["name", name], []) :: rest ->
11653 (* Look up the reference. Because of limitations in this parser,
11654 * we can't handle arbitrarily nested <ref> yet. You can only
11655 * use <ref> from inside <start>.
11657 (match defines with
11659 failwithf "%s: contains <ref>, but no refs are defined yet" context
11661 let rng = StringMap.find name map in
11662 rng @ parse_rng ?defines context rest
11665 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11668 let xml = Xml.parse_file rng_input in
11670 | Xml.Element ("grammar", _,
11671 Xml.Element ("start", _, gram) :: defines) ->
11672 (* The <define/> elements are referenced in the <start> section,
11673 * so build a map of those first.
11675 let defines = List.fold_left (
11677 function Xml.Element ("define", ["name", name], defn) ->
11678 StringMap.add name defn map
11680 failwithf "%s: expected <define name=name/>" rng_input
11681 ) StringMap.empty defines in
11682 let defines = StringMap.mapi parse_rng defines in
11684 (* Parse the <start> clause, passing the defines. *)
11685 parse_rng ~defines "<start>" gram
11687 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11690 let name_of_field = function
11691 | Element (name, _) | Attribute (name, _)
11692 | ZeroOrMore (Element (name, _))
11693 | OneOrMore (Element (name, _))
11694 | Optional (Element (name, _)) -> name
11695 | Optional (Attribute (name, _)) -> name
11696 | Text -> (* an unnamed field in an element *)
11699 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11701 (* At the moment this function only generates OCaml types. However we
11702 * should parameterize it later so it can generate types/structs in a
11703 * variety of languages.
11705 let generate_types xs =
11706 (* A simple type is one that can be printed out directly, eg.
11707 * "string option". A complex type is one which has a name and has
11708 * to be defined via another toplevel definition, eg. a struct.
11710 * generate_type generates code for either simple or complex types.
11711 * In the simple case, it returns the string ("string option"). In
11712 * the complex case, it returns the name ("mountpoint"). In the
11713 * complex case it has to print out the definition before returning,
11714 * so it should only be called when we are at the beginning of a
11715 * new line (BOL context).
11717 let rec generate_type = function
11718 | Text -> (* string *)
11720 | Choice values -> (* [`val1|`val2|...] *)
11721 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11722 | ZeroOrMore rng -> (* <rng> list *)
11723 let t, is_simple = generate_type rng in
11724 t ^ " list (* 0 or more *)", is_simple
11725 | OneOrMore rng -> (* <rng> list *)
11726 let t, is_simple = generate_type rng in
11727 t ^ " list (* 1 or more *)", is_simple
11728 (* virt-inspector hack: bool *)
11729 | Optional (Attribute (name, [Value "1"])) ->
11731 | Optional rng -> (* <rng> list *)
11732 let t, is_simple = generate_type rng in
11733 t ^ " option", is_simple
11734 (* type name = { fields ... } *)
11735 | Element (name, fields) when is_attrs_interleave fields ->
11736 generate_type_struct name (get_attrs_interleave fields)
11737 | Element (name, [field]) (* type name = field *)
11738 | Attribute (name, [field]) ->
11739 let t, is_simple = generate_type field in
11740 if is_simple then (t, true)
11742 pr "type %s = %s\n" name t;
11745 | Element (name, fields) -> (* type name = { fields ... } *)
11746 generate_type_struct name fields
11748 failwithf "generate_type failed at: %s" (string_of_rng rng)
11750 and is_attrs_interleave = function
11751 | [Interleave _] -> true
11752 | Attribute _ :: fields -> is_attrs_interleave fields
11753 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11756 and get_attrs_interleave = function
11757 | [Interleave fields] -> fields
11758 | ((Attribute _) as field) :: fields
11759 | ((Optional (Attribute _)) as field) :: fields ->
11760 field :: get_attrs_interleave fields
11761 | _ -> assert false
11763 and generate_types xs =
11764 List.iter (fun x -> ignore (generate_type x)) xs
11766 and generate_type_struct name fields =
11767 (* Calculate the types of the fields first. We have to do this
11768 * before printing anything so we are still in BOL context.
11770 let types = List.map fst (List.map generate_type fields) in
11772 (* Special case of a struct containing just a string and another
11773 * field. Turn it into an assoc list.
11776 | ["string"; other] ->
11777 let fname1, fname2 =
11779 | [f1; f2] -> name_of_field f1, name_of_field f2
11780 | _ -> assert false in
11781 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11785 pr "type %s = {\n" name;
11787 fun (field, ftype) ->
11788 let fname = name_of_field field in
11789 pr " %s_%s : %s;\n" name fname ftype
11790 ) (List.combine fields types);
11792 (* Return the name of this type, and
11793 * false because it's not a simple type.
11800 let generate_parsers xs =
11801 (* As for generate_type above, generate_parser makes a parser for
11802 * some type, and returns the name of the parser it has generated.
11803 * Because it (may) need to print something, it should always be
11804 * called in BOL context.
11806 let rec generate_parser = function
11807 | Text -> (* string *)
11808 "string_child_or_empty"
11809 | Choice values -> (* [`val1|`val2|...] *)
11810 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11812 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11813 | ZeroOrMore rng -> (* <rng> list *)
11814 let pa = generate_parser rng in
11815 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11816 | OneOrMore rng -> (* <rng> list *)
11817 let pa = generate_parser rng in
11818 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11819 (* virt-inspector hack: bool *)
11820 | Optional (Attribute (name, [Value "1"])) ->
11821 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11822 | Optional rng -> (* <rng> list *)
11823 let pa = generate_parser rng in
11824 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11825 (* type name = { fields ... } *)
11826 | Element (name, fields) when is_attrs_interleave fields ->
11827 generate_parser_struct name (get_attrs_interleave fields)
11828 | Element (name, [field]) -> (* type name = field *)
11829 let pa = generate_parser field in
11830 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11831 pr "let %s =\n" parser_name;
11833 pr "let parse_%s = %s\n" name parser_name;
11835 | Attribute (name, [field]) ->
11836 let pa = generate_parser field in
11837 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11838 pr "let %s =\n" parser_name;
11840 pr "let parse_%s = %s\n" name parser_name;
11842 | Element (name, fields) -> (* type name = { fields ... } *)
11843 generate_parser_struct name ([], fields)
11845 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11847 and is_attrs_interleave = function
11848 | [Interleave _] -> true
11849 | Attribute _ :: fields -> is_attrs_interleave fields
11850 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11853 and get_attrs_interleave = function
11854 | [Interleave fields] -> [], fields
11855 | ((Attribute _) as field) :: fields
11856 | ((Optional (Attribute _)) as field) :: fields ->
11857 let attrs, interleaves = get_attrs_interleave fields in
11858 (field :: attrs), interleaves
11859 | _ -> assert false
11861 and generate_parsers xs =
11862 List.iter (fun x -> ignore (generate_parser x)) xs
11864 and generate_parser_struct name (attrs, interleaves) =
11865 (* Generate parsers for the fields first. We have to do this
11866 * before printing anything so we are still in BOL context.
11868 let fields = attrs @ interleaves in
11869 let pas = List.map generate_parser fields in
11871 (* Generate an intermediate tuple from all the fields first.
11872 * If the type is just a string + another field, then we will
11873 * return this directly, otherwise it is turned into a record.
11875 * RELAX NG note: This code treats <interleave> and plain lists of
11876 * fields the same. In other words, it doesn't bother enforcing
11877 * any ordering of fields in the XML.
11879 pr "let parse_%s x =\n" name;
11880 pr " let t = (\n ";
11881 let comma = ref false in
11884 if !comma then pr ",\n ";
11887 | Optional (Attribute (fname, [field])), pa ->
11889 | Optional (Element (fname, [field])), pa ->
11890 pr "%s (optional_child %S x)" pa fname
11891 | Attribute (fname, [Text]), _ ->
11892 pr "attribute %S x" fname
11893 | (ZeroOrMore _ | OneOrMore _), pa ->
11898 let fname = name_of_field field in
11899 pr "%s (child %S x)" pa fname
11900 ) (List.combine fields pas);
11904 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11908 pr " (Obj.magic t : %s)\n" name
11912 | (Optional (Attribute (fname, [field])), pa) ->
11913 pr " %s_%s =\n" name fname;
11915 | (Optional (Element (fname, [field])), pa) ->
11916 pr " %s_%s =\n" name fname;
11917 pr " (let x = optional_child %S x in\n" fname;
11920 let fname = name_of_field field in
11921 pr " %s_%s =\n" name fname;
11922 pr " (let x = child %S x in\n" fname;
11924 ) (List.combine fields pas);
11928 sprintf "parse_%s" name
11931 generate_parsers xs
11933 (* Generate ocaml/guestfs_inspector.mli. *)
11934 let generate_ocaml_inspector_mli () =
11935 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11938 (** This is an OCaml language binding to the external [virt-inspector]
11941 For more information, please read the man page [virt-inspector(1)].
11946 generate_types grammar;
11947 pr "(** The nested information returned from the {!inspect} function. *)\n";
11951 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11952 (** To inspect a libvirt domain called [name], pass a singleton
11953 list: [inspect [name]]. When using libvirt only, you may
11954 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11956 To inspect a disk image or images, pass a list of the filenames
11957 of the disk images: [inspect filenames]
11959 This function inspects the given guest or disk images and
11960 returns a list of operating system(s) found and a large amount
11961 of information about them. In the vast majority of cases,
11962 a virtual machine only contains a single operating system.
11964 If the optional [~xml] parameter is given, then this function
11965 skips running the external virt-inspector program and just
11966 parses the given XML directly (which is expected to be XML
11967 produced from a previous run of virt-inspector). The list of
11968 names and connect URI are ignored in this case.
11970 This function can throw a wide variety of exceptions, for example
11971 if the external virt-inspector program cannot be found, or if
11972 it doesn't generate valid XML.
11976 (* Generate ocaml/guestfs_inspector.ml. *)
11977 let generate_ocaml_inspector_ml () =
11978 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11983 generate_types grammar;
11987 (* Misc functions which are used by the parser code below. *)
11988 let first_child = function
11989 | Xml.Element (_, _, c::_) -> c
11990 | Xml.Element (name, _, []) ->
11991 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11992 | Xml.PCData str ->
11993 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11995 let string_child_or_empty = function
11996 | Xml.Element (_, _, [Xml.PCData s]) -> s
11997 | Xml.Element (_, _, []) -> \"\"
11998 | Xml.Element (x, _, _) ->
11999 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
12001 | Xml.PCData str ->
12002 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
12004 let optional_child name xml =
12005 let children = Xml.children xml in
12007 Some (List.find (function
12008 | Xml.Element (n, _, _) when n = name -> true
12009 | _ -> false) children)
12013 let child name xml =
12014 match optional_child name xml with
12017 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
12019 let attribute name xml =
12020 try Xml.attrib xml name
12021 with Xml.No_attribute _ ->
12022 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
12026 generate_parsers grammar;
12030 (* Run external virt-inspector, then use parser to parse the XML. *)
12031 let inspect ?connect ?xml names =
12035 if names = [] then invalid_arg \"inspect: no names given\";
12036 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
12037 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
12039 let cmd = List.map Filename.quote cmd in
12040 let cmd = String.concat \" \" cmd in
12041 let chan = open_process_in cmd in
12042 let xml = Xml.parse_in chan in
12043 (match close_process_in chan with
12045 | WEXITED _ -> failwith \"external virt-inspector command failed\"
12046 | WSIGNALED i | WSTOPPED i ->
12047 failwith (\"external virt-inspector command died or stopped on sig \" ^
12052 Xml.parse_string doc in
12053 parse_operatingsystems xml
12056 and generate_max_proc_nr () =
12057 pr "%d\n" max_proc_nr
12059 let output_to filename k =
12060 let filename_new = filename ^ ".new" in
12061 chan := open_out filename_new;
12064 chan := Pervasives.stdout;
12066 (* Is the new file different from the current file? *)
12067 if Sys.file_exists filename && files_equal filename filename_new then
12068 unlink filename_new (* same, so skip it *)
12070 (* different, overwrite old one *)
12071 (try chmod filename 0o644 with Unix_error _ -> ());
12072 rename filename_new filename;
12073 chmod filename 0o444;
12074 printf "written %s\n%!" filename;
12077 let perror msg = function
12078 | Unix_error (err, _, _) ->
12079 eprintf "%s: %s\n" msg (error_message err)
12081 eprintf "%s: %s\n" msg (Printexc.to_string exn)
12083 (* Main program. *)
12086 try openfile "HACKING" [O_RDWR] 0
12088 | Unix_error (ENOENT, _, _) ->
12090 You are probably running this from the wrong directory.
12091 Run it from the top source directory using the command
12096 perror "open: HACKING" exn;
12099 (* Acquire a lock so parallel builds won't try to run the generator
12100 * twice at the same time. Subsequent builds will wait for the first
12101 * one to finish. Note the lock is released implicitly when the
12104 (try lockf lock_fd F_LOCK 1
12106 perror "lock: HACKING" exn;
12109 check_functions ();
12111 output_to "src/guestfs_protocol.x" generate_xdr;
12112 output_to "src/guestfs-structs.h" generate_structs_h;
12113 output_to "src/guestfs-actions.h" generate_actions_h;
12114 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
12115 output_to "src/guestfs-actions.c" generate_client_actions;
12116 output_to "src/guestfs-bindtests.c" generate_bindtests;
12117 output_to "src/guestfs-structs.pod" generate_structs_pod;
12118 output_to "src/guestfs-actions.pod" generate_actions_pod;
12119 output_to "src/guestfs-availability.pod" generate_availability_pod;
12120 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
12121 output_to "src/libguestfs.syms" generate_linker_script;
12122 output_to "daemon/actions.h" generate_daemon_actions_h;
12123 output_to "daemon/stubs.c" generate_daemon_actions;
12124 output_to "daemon/names.c" generate_daemon_names;
12125 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
12126 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
12127 output_to "capitests/tests.c" generate_tests;
12128 output_to "fish/cmds.c" generate_fish_cmds;
12129 output_to "fish/completion.c" generate_fish_completion;
12130 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
12131 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
12132 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
12133 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
12134 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
12135 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
12136 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
12137 output_to "perl/Guestfs.xs" generate_perl_xs;
12138 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
12139 output_to "perl/bindtests.pl" generate_perl_bindtests;
12140 output_to "python/guestfs-py.c" generate_python_c;
12141 output_to "python/guestfs.py" generate_python_py;
12142 output_to "python/bindtests.py" generate_python_bindtests;
12143 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12144 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12145 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12149 let cols = cols_of_struct typ in
12150 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12151 output_to filename (generate_java_struct jtyp cols);
12154 output_to "java/Makefile.inc" generate_java_makefile_inc;
12155 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12156 output_to "java/Bindtests.java" generate_java_bindtests;
12157 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12158 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12159 output_to "csharp/Libguestfs.cs" generate_csharp;
12161 (* Always generate this file last, and unconditionally. It's used
12162 * by the Makefile to know when we must re-run the generator.
12164 let chan = open_out "src/stamp-generator" in
12165 fprintf chan "1\n";
12168 printf "generated %d lines of code\n" !lines