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_close_callback";
6341 "guestfs_set_error_handler";
6342 "guestfs_set_launch_done_callback";
6343 "guestfs_set_log_message_callback";
6344 "guestfs_set_out_of_memory_handler";
6345 "guestfs_set_subprocess_quit_callback";
6347 (* Unofficial parts of the API: the bindings code use these
6348 * functions, so it is useful to export them.
6350 "guestfs_safe_calloc";
6351 "guestfs_safe_malloc";
6354 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6358 List.map (fun (typ, _) ->
6359 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6362 let globals = List.sort compare (globals @ functions @ structs) in
6366 List.iter (pr " %s;\n") globals;
6373 (* Generate the server-side stubs. *)
6374 and generate_daemon_actions () =
6375 generate_header CStyle GPLv2plus;
6377 pr "#include <config.h>\n";
6379 pr "#include <stdio.h>\n";
6380 pr "#include <stdlib.h>\n";
6381 pr "#include <string.h>\n";
6382 pr "#include <inttypes.h>\n";
6383 pr "#include <rpc/types.h>\n";
6384 pr "#include <rpc/xdr.h>\n";
6386 pr "#include \"daemon.h\"\n";
6387 pr "#include \"c-ctype.h\"\n";
6388 pr "#include \"../src/guestfs_protocol.h\"\n";
6389 pr "#include \"actions.h\"\n";
6393 fun (name, style, _, _, _, _, _) ->
6394 (* Generate server-side stubs. *)
6395 pr "static void %s_stub (XDR *xdr_in)\n" name;
6398 match fst style with
6399 | RErr | RInt _ -> pr " int r;\n"; "-1"
6400 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6401 | RBool _ -> pr " int r;\n"; "-1"
6402 | RConstString _ | RConstOptString _ ->
6403 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6404 | RString _ -> pr " char *r;\n"; "NULL"
6405 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6406 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6407 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6409 pr " size_t size = 1;\n";
6413 (match snd style with
6416 pr " struct guestfs_%s_args args;\n" name;
6419 | Device n | Dev_or_Path n
6422 | OptString n -> pr " char *%s;\n" n
6423 | StringList n | DeviceList n -> pr " char **%s;\n" n
6424 | Bool n -> pr " int %s;\n" n
6425 | Int n -> pr " int %s;\n" n
6426 | Int64 n -> pr " int64_t %s;\n" n
6427 | FileIn _ | FileOut _ -> ()
6429 pr " const char *%s;\n" n;
6430 pr " size_t %s_size;\n" n
6436 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6438 (match snd style with
6441 pr " memset (&args, 0, sizeof args);\n";
6443 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6445 pr " if (cancel_receive () != -2)\n";
6446 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6450 pr " char *%s = args.%s;\n" n n
6452 let pr_list_handling_code n =
6453 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6454 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6455 pr " if (%s == NULL) {\n" n;
6457 pr " if (cancel_receive () != -2)\n";
6458 pr " reply_with_perror (\"realloc\");\n";
6461 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6462 pr " args.%s.%s_val = %s;\n" n n n;
6468 pr " ABS_PATH (%s, %s, goto done);\n"
6469 n (if is_filein then "cancel_receive ()" else "0");
6472 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6473 n (if is_filein then "cancel_receive ()" else "0");
6476 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6477 n (if is_filein then "cancel_receive ()" else "0");
6478 | String n -> pr_args n
6479 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6481 pr_list_handling_code n;
6483 pr_list_handling_code n;
6484 pr " /* Ensure that each is a device,\n";
6485 pr " * and perform device name translation. */\n";
6486 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6487 pr " RESOLVE_DEVICE (physvols[pvi], %s, goto done);\n"
6488 (if is_filein then "cancel_receive ()" else "0");
6490 | Bool n -> pr " %s = args.%s;\n" n n
6491 | Int n -> pr " %s = args.%s;\n" n n
6492 | Int64 n -> pr " %s = args.%s;\n" n n
6493 | FileIn _ | FileOut _ -> ()
6495 pr " %s = args.%s.%s_val;\n" n n n;
6496 pr " %s_size = args.%s.%s_len;\n" n n n
6501 (* this is used at least for do_equal *)
6502 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6503 (* Emit NEED_ROOT just once, even when there are two or
6504 more Pathname args *)
6505 pr " NEED_ROOT (%s, goto done);\n"
6506 (if is_filein then "cancel_receive ()" else "0");
6509 (* Don't want to call the impl with any FileIn or FileOut
6510 * parameters, since these go "outside" the RPC protocol.
6513 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6515 pr " r = do_%s " name;
6516 generate_c_call_args (fst style, args');
6519 (match fst style with
6520 | RErr | RInt _ | RInt64 _ | RBool _
6521 | RConstString _ | RConstOptString _
6522 | RString _ | RStringList _ | RHashtable _
6523 | RStruct (_, _) | RStructList (_, _) ->
6524 pr " if (r == %s)\n" error_code;
6525 pr " /* do_%s has already called reply_with_error */\n" name;
6529 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6530 pr " * an ordinary zero-length buffer), so be careful ...\n";
6532 pr " if (size == 1 && r == %s)\n" error_code;
6533 pr " /* do_%s has already called reply_with_error */\n" name;
6538 (* If there are any FileOut parameters, then the impl must
6539 * send its own reply.
6542 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6544 pr " /* do_%s has already sent a reply */\n" name
6546 match fst style with
6547 | RErr -> pr " reply (NULL, NULL);\n"
6548 | RInt n | RInt64 n | RBool n ->
6549 pr " struct guestfs_%s_ret ret;\n" name;
6550 pr " ret.%s = r;\n" n;
6551 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6553 | RConstString _ | RConstOptString _ ->
6554 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6556 pr " struct guestfs_%s_ret ret;\n" name;
6557 pr " ret.%s = r;\n" n;
6558 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6561 | RStringList n | RHashtable n ->
6562 pr " struct guestfs_%s_ret ret;\n" name;
6563 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6564 pr " ret.%s.%s_val = r;\n" n n;
6565 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6567 pr " free_strings (r);\n"
6569 pr " struct guestfs_%s_ret ret;\n" name;
6570 pr " ret.%s = *r;\n" n;
6571 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6573 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6575 | RStructList (n, _) ->
6576 pr " struct guestfs_%s_ret ret;\n" name;
6577 pr " ret.%s = *r;\n" n;
6578 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6580 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6583 pr " struct guestfs_%s_ret ret;\n" name;
6584 pr " ret.%s.%s_val = r;\n" n n;
6585 pr " ret.%s.%s_len = size;\n" n n;
6586 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6591 (* Free the args. *)
6593 (match snd style with
6596 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6603 (* Dispatch function. *)
6604 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6606 pr " switch (proc_nr) {\n";
6609 fun (name, style, _, _, _, _, _) ->
6610 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6611 pr " %s_stub (xdr_in);\n" name;
6616 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";
6621 (* LVM columns and tokenization functions. *)
6622 (* XXX This generates crap code. We should rethink how we
6628 pr "static const char *lvm_%s_cols = \"%s\";\n"
6629 typ (String.concat "," (List.map fst cols));
6632 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6634 pr " char *tok, *p, *next;\n";
6638 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6641 pr " if (!str) {\n";
6642 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6645 pr " if (!*str || c_isspace (*str)) {\n";
6646 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6651 fun (name, coltype) ->
6652 pr " if (!tok) {\n";
6653 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6656 pr " p = strchrnul (tok, ',');\n";
6657 pr " if (*p) next = p+1; else next = NULL;\n";
6658 pr " *p = '\\0';\n";
6661 pr " r->%s = strdup (tok);\n" name;
6662 pr " if (r->%s == NULL) {\n" name;
6663 pr " perror (\"strdup\");\n";
6667 pr " for (i = j = 0; i < 32; ++j) {\n";
6668 pr " if (tok[j] == '\\0') {\n";
6669 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6671 pr " } else if (tok[j] != '-')\n";
6672 pr " r->%s[i++] = tok[j];\n" name;
6675 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6676 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6680 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6681 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6685 pr " if (tok[0] == '\\0')\n";
6686 pr " r->%s = -1;\n" name;
6687 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6688 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6691 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6692 assert false (* can never be an LVM column *)
6694 pr " tok = next;\n";
6697 pr " if (tok != NULL) {\n";
6698 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6705 pr "guestfs_int_lvm_%s_list *\n" typ;
6706 pr "parse_command_line_%ss (void)\n" typ;
6708 pr " char *out, *err;\n";
6709 pr " char *p, *pend;\n";
6711 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6712 pr " void *newp;\n";
6714 pr " ret = malloc (sizeof *ret);\n";
6715 pr " if (!ret) {\n";
6716 pr " reply_with_perror (\"malloc\");\n";
6717 pr " return NULL;\n";
6720 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6721 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6723 pr " r = command (&out, &err,\n";
6724 pr " \"lvm\", \"%ss\",\n" typ;
6725 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6726 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6727 pr " if (r == -1) {\n";
6728 pr " reply_with_error (\"%%s\", err);\n";
6729 pr " free (out);\n";
6730 pr " free (err);\n";
6731 pr " free (ret);\n";
6732 pr " return NULL;\n";
6735 pr " free (err);\n";
6737 pr " /* Tokenize each line of the output. */\n";
6740 pr " while (p) {\n";
6741 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6742 pr " if (pend) {\n";
6743 pr " *pend = '\\0';\n";
6747 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6750 pr " if (!*p) { /* Empty line? Skip it. */\n";
6755 pr " /* Allocate some space to store this next entry. */\n";
6756 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6757 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6758 pr " if (newp == NULL) {\n";
6759 pr " reply_with_perror (\"realloc\");\n";
6760 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6761 pr " free (ret);\n";
6762 pr " free (out);\n";
6763 pr " return NULL;\n";
6765 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6767 pr " /* Tokenize the next entry. */\n";
6768 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6769 pr " if (r == -1) {\n";
6770 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6771 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6772 pr " free (ret);\n";
6773 pr " free (out);\n";
6774 pr " return NULL;\n";
6781 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6783 pr " free (out);\n";
6784 pr " return ret;\n";
6787 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6789 (* Generate a list of function names, for debugging in the daemon.. *)
6790 and generate_daemon_names () =
6791 generate_header CStyle GPLv2plus;
6793 pr "#include <config.h>\n";
6795 pr "#include \"daemon.h\"\n";
6798 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6799 pr "const char *function_names[] = {\n";
6801 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6805 (* Generate the optional groups for the daemon to implement
6806 * guestfs_available.
6808 and generate_daemon_optgroups_c () =
6809 generate_header CStyle GPLv2plus;
6811 pr "#include <config.h>\n";
6813 pr "#include \"daemon.h\"\n";
6814 pr "#include \"optgroups.h\"\n";
6817 pr "struct optgroup optgroups[] = {\n";
6820 pr " { \"%s\", optgroup_%s_available },\n" group group
6822 pr " { NULL, NULL }\n";
6825 and generate_daemon_optgroups_h () =
6826 generate_header CStyle GPLv2plus;
6830 pr "extern int optgroup_%s_available (void);\n" group
6833 (* Generate the tests. *)
6834 and generate_tests () =
6835 generate_header CStyle GPLv2plus;
6842 #include <sys/types.h>
6845 #include \"guestfs.h\"
6846 #include \"guestfs-internal.h\"
6848 static guestfs_h *g;
6849 static int suppress_error = 0;
6851 static void print_error (guestfs_h *g, void *data, const char *msg)
6853 if (!suppress_error)
6854 fprintf (stderr, \"%%s\\n\", msg);
6857 /* FIXME: nearly identical code appears in fish.c */
6858 static void print_strings (char *const *argv)
6862 for (argc = 0; argv[argc] != NULL; ++argc)
6863 printf (\"\\t%%s\\n\", argv[argc]);
6867 static void print_table (char const *const *argv)
6871 for (i = 0; argv[i] != NULL; i += 2)
6872 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6877 is_available (const char *group)
6879 const char *groups[] = { group, NULL };
6883 r = guestfs_available (g, (char **) groups);
6890 incr (guestfs_h *g, void *iv)
6892 int *i = (int *) iv;
6898 (* Generate a list of commands which are not tested anywhere. *)
6899 pr "static void no_test_warnings (void)\n";
6902 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6904 fun (_, _, _, _, tests, _, _) ->
6905 let tests = filter_map (
6907 | (_, (Always|If _|Unless _|IfAvailable _), test) -> Some test
6908 | (_, Disabled, _) -> None
6910 let seq = List.concat (List.map seq_of_test tests) in
6911 let cmds_tested = List.map List.hd seq in
6912 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6916 fun (name, _, _, _, _, _, _) ->
6917 if not (Hashtbl.mem hash name) then
6918 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6924 (* Generate the actual tests. Note that we generate the tests
6925 * in reverse order, deliberately, so that (in general) the
6926 * newest tests run first. This makes it quicker and easier to
6931 fun (name, _, _, flags, tests, _, _) ->
6932 mapi (generate_one_test name flags) tests
6933 ) (List.rev all_functions) in
6934 let test_names = List.concat test_names in
6935 let nr_tests = List.length test_names in
6938 int main (int argc, char *argv[])
6941 unsigned long int n_failed = 0;
6942 const char *filename;
6944 int nr_tests, test_num = 0;
6946 setbuf (stdout, NULL);
6948 no_test_warnings ();
6950 g = guestfs_create ();
6952 printf (\"guestfs_create FAILED\\n\");
6953 exit (EXIT_FAILURE);
6956 guestfs_set_error_handler (g, print_error, NULL);
6958 guestfs_set_path (g, \"../appliance\");
6960 filename = \"test1.img\";
6961 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6964 exit (EXIT_FAILURE);
6966 if (lseek (fd, %d, SEEK_SET) == -1) {
6970 exit (EXIT_FAILURE);
6972 if (write (fd, &c, 1) == -1) {
6976 exit (EXIT_FAILURE);
6978 if (close (fd) == -1) {
6981 exit (EXIT_FAILURE);
6983 if (guestfs_add_drive (g, filename) == -1) {
6984 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6985 exit (EXIT_FAILURE);
6988 filename = \"test2.img\";
6989 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6992 exit (EXIT_FAILURE);
6994 if (lseek (fd, %d, SEEK_SET) == -1) {
6998 exit (EXIT_FAILURE);
7000 if (write (fd, &c, 1) == -1) {
7004 exit (EXIT_FAILURE);
7006 if (close (fd) == -1) {
7009 exit (EXIT_FAILURE);
7011 if (guestfs_add_drive (g, filename) == -1) {
7012 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7013 exit (EXIT_FAILURE);
7016 filename = \"test3.img\";
7017 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
7020 exit (EXIT_FAILURE);
7022 if (lseek (fd, %d, SEEK_SET) == -1) {
7026 exit (EXIT_FAILURE);
7028 if (write (fd, &c, 1) == -1) {
7032 exit (EXIT_FAILURE);
7034 if (close (fd) == -1) {
7037 exit (EXIT_FAILURE);
7039 if (guestfs_add_drive (g, filename) == -1) {
7040 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
7041 exit (EXIT_FAILURE);
7044 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
7045 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
7046 exit (EXIT_FAILURE);
7049 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
7052 if (guestfs_launch (g) == -1) {
7053 printf (\"guestfs_launch FAILED\\n\");
7054 exit (EXIT_FAILURE);
7057 /* Cancel previous alarm. */
7062 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
7066 pr " test_num++;\n";
7067 pr " if (guestfs_get_verbose (g))\n";
7068 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
7069 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
7070 pr " if (%s () == -1) {\n" test_name;
7071 pr " printf (\"%s FAILED\\n\");\n" test_name;
7072 pr " n_failed++;\n";
7077 pr " /* Check close callback is called. */
7078 int close_sentinel = 1;
7079 guestfs_set_close_callback (g, incr, &close_sentinel);
7083 if (close_sentinel != 2) {
7084 fprintf (stderr, \"close callback was not called\\n\");
7085 exit (EXIT_FAILURE);
7088 unlink (\"test1.img\");
7089 unlink (\"test2.img\");
7090 unlink (\"test3.img\");
7094 pr " if (n_failed > 0) {\n";
7095 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
7096 pr " exit (EXIT_FAILURE);\n";
7100 pr " exit (EXIT_SUCCESS);\n";
7103 and generate_one_test name flags i (init, prereq, test) =
7104 let test_name = sprintf "test_%s_%d" name i in
7107 static int %s_skip (void)
7111 str = getenv (\"TEST_ONLY\");
7113 return strstr (str, \"%s\") == NULL;
7114 str = getenv (\"SKIP_%s\");
7115 if (str && STREQ (str, \"1\")) return 1;
7116 str = getenv (\"SKIP_TEST_%s\");
7117 if (str && STREQ (str, \"1\")) return 1;
7121 " test_name name (String.uppercase test_name) (String.uppercase name);
7124 | Disabled | Always | IfAvailable _ -> ()
7125 | If code | Unless code ->
7126 pr "static int %s_prereq (void)\n" test_name;
7134 static int %s (void)
7137 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
7141 " test_name test_name test_name;
7143 (* Optional functions should only be tested if the relevant
7144 * support is available in the daemon.
7149 pr " if (!is_available (\"%s\")) {\n" group;
7150 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", \"%s\");\n" test_name group;
7158 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7160 pr " if (! %s_prereq ()) {\n" test_name;
7161 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7165 generate_one_test_body name i test_name init test;
7167 pr " if (%s_prereq ()) {\n" test_name;
7168 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7172 generate_one_test_body name i test_name init test;
7173 | IfAvailable group ->
7174 pr " if (!is_available (\"%s\")) {\n" group;
7175 pr " printf (\" %%s skipped (reason: %%s not available)\\n\", \"%s\", \"%s\");\n" test_name group;
7179 generate_one_test_body name i test_name init test;
7181 generate_one_test_body name i test_name init test
7189 and generate_one_test_body name i test_name init test =
7191 | InitNone (* XXX at some point, InitNone and InitEmpty became
7192 * folded together as the same thing. Really we should
7193 * make InitNone do nothing at all, but the tests may
7194 * need to be checked to make sure this is OK.
7197 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7198 List.iter (generate_test_command_call test_name)
7199 [["blockdev_setrw"; "/dev/sda"];
7203 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7204 List.iter (generate_test_command_call test_name)
7205 [["blockdev_setrw"; "/dev/sda"];
7208 ["part_disk"; "/dev/sda"; "mbr"]]
7210 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7211 List.iter (generate_test_command_call test_name)
7212 [["blockdev_setrw"; "/dev/sda"];
7215 ["part_disk"; "/dev/sda"; "mbr"];
7216 ["mkfs"; "ext2"; "/dev/sda1"];
7217 ["mount_options"; ""; "/dev/sda1"; "/"]]
7218 | InitBasicFSonLVM ->
7219 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7221 List.iter (generate_test_command_call test_name)
7222 [["blockdev_setrw"; "/dev/sda"];
7225 ["part_disk"; "/dev/sda"; "mbr"];
7226 ["pvcreate"; "/dev/sda1"];
7227 ["vgcreate"; "VG"; "/dev/sda1"];
7228 ["lvcreate"; "LV"; "VG"; "8"];
7229 ["mkfs"; "ext2"; "/dev/VG/LV"];
7230 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7232 pr " /* InitISOFS for %s */\n" test_name;
7233 List.iter (generate_test_command_call test_name)
7234 [["blockdev_setrw"; "/dev/sda"];
7237 ["mount_ro"; "/dev/sdd"; "/"]]
7240 let get_seq_last = function
7242 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7245 let seq = List.rev seq in
7246 List.rev (List.tl seq), List.hd seq
7251 pr " /* TestRun for %s (%d) */\n" name i;
7252 List.iter (generate_test_command_call test_name) seq
7253 | TestOutput (seq, expected) ->
7254 pr " /* TestOutput for %s (%d) */\n" name i;
7255 pr " const char *expected = \"%s\";\n" (c_quote expected);
7256 let seq, last = get_seq_last seq in
7258 pr " if (STRNEQ (r, expected)) {\n";
7259 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7263 List.iter (generate_test_command_call test_name) seq;
7264 generate_test_command_call ~test test_name last
7265 | TestOutputList (seq, expected) ->
7266 pr " /* TestOutputList for %s (%d) */\n" name i;
7267 let seq, last = get_seq_last seq in
7271 pr " if (!r[%d]) {\n" i;
7272 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7273 pr " print_strings (r);\n";
7277 pr " const char *expected = \"%s\";\n" (c_quote str);
7278 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7279 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7284 pr " if (r[%d] != NULL) {\n" (List.length expected);
7285 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7287 pr " print_strings (r);\n";
7291 List.iter (generate_test_command_call test_name) seq;
7292 generate_test_command_call ~test test_name last
7293 | TestOutputListOfDevices (seq, expected) ->
7294 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7295 let seq, last = get_seq_last seq in
7299 pr " if (!r[%d]) {\n" i;
7300 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7301 pr " print_strings (r);\n";
7305 pr " const char *expected = \"%s\";\n" (c_quote str);
7306 pr " r[%d][5] = 's';\n" i;
7307 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7308 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7313 pr " if (r[%d] != NULL) {\n" (List.length expected);
7314 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7316 pr " print_strings (r);\n";
7320 List.iter (generate_test_command_call test_name) seq;
7321 generate_test_command_call ~test test_name last
7322 | TestOutputInt (seq, expected) ->
7323 pr " /* TestOutputInt for %s (%d) */\n" name i;
7324 let seq, last = get_seq_last seq in
7326 pr " if (r != %d) {\n" expected;
7327 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7333 List.iter (generate_test_command_call test_name) seq;
7334 generate_test_command_call ~test test_name last
7335 | TestOutputIntOp (seq, op, expected) ->
7336 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7337 let seq, last = get_seq_last seq in
7339 pr " if (! (r %s %d)) {\n" op expected;
7340 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7341 test_name op expected;
7346 List.iter (generate_test_command_call test_name) seq;
7347 generate_test_command_call ~test test_name last
7348 | TestOutputTrue seq ->
7349 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7350 let seq, last = get_seq_last seq in
7353 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7358 List.iter (generate_test_command_call test_name) seq;
7359 generate_test_command_call ~test test_name last
7360 | TestOutputFalse seq ->
7361 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7362 let seq, last = get_seq_last seq in
7365 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7370 List.iter (generate_test_command_call test_name) seq;
7371 generate_test_command_call ~test test_name last
7372 | TestOutputLength (seq, expected) ->
7373 pr " /* TestOutputLength for %s (%d) */\n" name i;
7374 let seq, last = get_seq_last seq in
7377 pr " for (j = 0; j < %d; ++j)\n" expected;
7378 pr " if (r[j] == NULL) {\n";
7379 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7381 pr " print_strings (r);\n";
7384 pr " if (r[j] != NULL) {\n";
7385 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7387 pr " print_strings (r);\n";
7391 List.iter (generate_test_command_call test_name) seq;
7392 generate_test_command_call ~test test_name last
7393 | TestOutputBuffer (seq, expected) ->
7394 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7395 pr " const char *expected = \"%s\";\n" (c_quote expected);
7396 let seq, last = get_seq_last seq in
7397 let len = String.length expected in
7399 pr " if (size != %d) {\n" len;
7400 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7403 pr " if (STRNEQLEN (r, expected, size)) {\n";
7404 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7408 List.iter (generate_test_command_call test_name) seq;
7409 generate_test_command_call ~test test_name last
7410 | TestOutputStruct (seq, checks) ->
7411 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7412 let seq, last = get_seq_last seq in
7416 | CompareWithInt (field, expected) ->
7417 pr " if (r->%s != %d) {\n" field expected;
7418 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7419 test_name field expected;
7420 pr " (int) r->%s);\n" field;
7423 | CompareWithIntOp (field, op, expected) ->
7424 pr " if (!(r->%s %s %d)) {\n" field op expected;
7425 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7426 test_name field op expected;
7427 pr " (int) r->%s);\n" field;
7430 | CompareWithString (field, expected) ->
7431 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7432 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7433 test_name field expected;
7434 pr " r->%s);\n" field;
7437 | CompareFieldsIntEq (field1, field2) ->
7438 pr " if (r->%s != r->%s) {\n" field1 field2;
7439 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7440 test_name field1 field2;
7441 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7444 | CompareFieldsStrEq (field1, field2) ->
7445 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7446 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7447 test_name field1 field2;
7448 pr " r->%s, r->%s);\n" field1 field2;
7453 List.iter (generate_test_command_call test_name) seq;
7454 generate_test_command_call ~test test_name last
7455 | TestLastFail seq ->
7456 pr " /* TestLastFail for %s (%d) */\n" name i;
7457 let seq, last = get_seq_last seq in
7458 List.iter (generate_test_command_call test_name) seq;
7459 generate_test_command_call test_name ~expect_error:true last
7461 (* Generate the code to run a command, leaving the result in 'r'.
7462 * If you expect to get an error then you should set expect_error:true.
7464 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7466 | [] -> assert false
7468 (* Look up the command to find out what args/ret it has. *)
7471 let _, style, _, _, _, _, _ =
7472 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7475 failwithf "%s: in test, command %s was not found" test_name name in
7477 if List.length (snd style) <> List.length args then
7478 failwithf "%s: in test, wrong number of args given to %s"
7485 | OptString n, "NULL" -> ()
7488 | Dev_or_Path n, arg
7490 | OptString n, arg ->
7491 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7492 | BufferIn n, arg ->
7493 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7494 pr " size_t %s_size = %d;\n" n (String.length arg)
7498 | FileIn _, _ | FileOut _, _ -> ()
7499 | StringList n, "" | DeviceList n, "" ->
7500 pr " const char *const %s[1] = { NULL };\n" n
7501 | StringList n, arg | DeviceList n, arg ->
7502 let strs = string_split " " arg in
7505 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7507 pr " const char *const %s[] = {\n" n;
7509 fun i _ -> pr " %s_%d,\n" n i
7513 ) (List.combine (snd style) args);
7516 match fst style with
7517 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7518 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7519 | RConstString _ | RConstOptString _ ->
7520 pr " const char *r;\n"; "NULL"
7521 | RString _ -> pr " char *r;\n"; "NULL"
7522 | RStringList _ | RHashtable _ ->
7526 | RStruct (_, typ) ->
7527 pr " struct guestfs_%s *r;\n" typ; "NULL"
7528 | RStructList (_, typ) ->
7529 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7532 pr " size_t size;\n";
7535 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7536 pr " r = guestfs_%s (g" name;
7538 (* Generate the parameters. *)
7541 | OptString _, "NULL" -> pr ", NULL"
7543 | Device n, _ | Dev_or_Path n, _
7548 pr ", %s, %s_size" n n
7549 | FileIn _, arg | FileOut _, arg ->
7550 pr ", \"%s\"" (c_quote arg)
7551 | StringList n, _ | DeviceList n, _ ->
7552 pr ", (char **) %s" n
7555 try int_of_string arg
7556 with Failure "int_of_string" ->
7557 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7561 try Int64.of_string arg
7562 with Failure "int_of_string" ->
7563 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7566 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7567 ) (List.combine (snd style) args);
7569 (match fst style with
7570 | RBufferOut _ -> pr ", &size"
7576 if not expect_error then
7577 pr " if (r == %s)\n" error_code
7579 pr " if (r != %s)\n" error_code;
7582 (* Insert the test code. *)
7588 (match fst style with
7589 | RErr | RInt _ | RInt64 _ | RBool _
7590 | RConstString _ | RConstOptString _ -> ()
7591 | RString _ | RBufferOut _ -> pr " free (r);\n"
7592 | RStringList _ | RHashtable _ ->
7593 pr " for (i = 0; r[i] != NULL; ++i)\n";
7594 pr " free (r[i]);\n";
7596 | RStruct (_, typ) ->
7597 pr " guestfs_free_%s (r);\n" typ
7598 | RStructList (_, typ) ->
7599 pr " guestfs_free_%s_list (r);\n" typ
7605 let str = replace_str str "\r" "\\r" in
7606 let str = replace_str str "\n" "\\n" in
7607 let str = replace_str str "\t" "\\t" in
7608 let str = replace_str str "\000" "\\0" in
7611 (* Generate a lot of different functions for guestfish. *)
7612 and generate_fish_cmds () =
7613 generate_header CStyle GPLv2plus;
7617 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7619 let all_functions_sorted =
7621 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7622 ) all_functions_sorted in
7624 pr "#include <config.h>\n";
7626 pr "#include <stdio.h>\n";
7627 pr "#include <stdlib.h>\n";
7628 pr "#include <string.h>\n";
7629 pr "#include <inttypes.h>\n";
7631 pr "#include <guestfs.h>\n";
7632 pr "#include \"c-ctype.h\"\n";
7633 pr "#include \"full-write.h\"\n";
7634 pr "#include \"xstrtol.h\"\n";
7635 pr "#include \"fish.h\"\n";
7637 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7638 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7641 (* list_commands function, which implements guestfish -h *)
7642 pr "void list_commands (void)\n";
7644 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7645 pr " list_builtin_commands ();\n";
7647 fun (name, _, _, flags, _, shortdesc, _) ->
7648 let name = replace_char name '_' '-' in
7649 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7651 ) all_functions_sorted;
7652 pr " printf (\" %%s\\n\",";
7653 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7657 (* display_command function, which implements guestfish -h cmd *)
7658 pr "int display_command (const char *cmd)\n";
7661 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7662 let name2 = replace_char name '_' '-' in
7664 try find_map (function FishAlias n -> Some n | _ -> None) flags
7665 with Not_found -> name in
7666 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7668 match snd style with
7672 name2 (String.concat " " (List.map name_of_argt args)) in
7675 if List.mem ProtocolLimitWarning flags then
7676 ("\n\n" ^ protocol_limit_warning)
7679 (* For DangerWillRobinson commands, we should probably have
7680 * guestfish prompt before allowing you to use them (especially
7681 * in interactive mode). XXX
7685 if List.mem DangerWillRobinson flags then
7686 ("\n\n" ^ danger_will_robinson)
7691 match deprecation_notice flags with
7693 | Some txt -> "\n\n" ^ txt in
7695 let describe_alias =
7696 if name <> alias then
7697 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7701 pr "STRCASEEQ (cmd, \"%s\")" name;
7702 if name <> name2 then
7703 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7704 if name <> alias then
7705 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7707 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7709 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7710 "=head1 DESCRIPTION\n\n" ^
7711 longdesc ^ warnings ^ describe_alias);
7716 pr " return display_builtin_command (cmd);\n";
7720 let emit_print_list_function typ =
7721 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7724 pr " unsigned int i;\n";
7726 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7727 pr " printf (\"[%%d] = {\\n\", i);\n";
7728 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7729 pr " printf (\"}\\n\");\n";
7735 (* print_* functions *)
7739 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7741 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7744 pr " unsigned int i;\n";
7750 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7752 pr " printf (\"%%s%s: \", indent);\n" name;
7753 pr " for (i = 0; i < 32; ++i)\n";
7754 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7755 pr " printf (\"\\n\");\n"
7757 pr " printf (\"%%s%s: \", indent);\n" name;
7758 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7759 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7760 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7762 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7763 pr " printf (\"\\n\");\n"
7764 | name, (FUInt64|FBytes) ->
7765 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7768 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7771 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7774 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7777 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7779 | name, FOptPercent ->
7780 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7781 typ name name typ name;
7782 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7788 (* Emit a print_TYPE_list function definition only if that function is used. *)
7791 | typ, (RStructListOnly | RStructAndList) ->
7792 (* generate the function for typ *)
7793 emit_print_list_function typ
7794 | typ, _ -> () (* empty *)
7795 ) (rstructs_used_by all_functions);
7797 (* Emit a print_TYPE function definition only if that function is used. *)
7800 | typ, (RStructOnly | RStructAndList) ->
7801 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7803 pr " print_%s_indent (%s, \"\");\n" typ typ;
7806 | typ, _ -> () (* empty *)
7807 ) (rstructs_used_by all_functions);
7809 (* run_<action> actions *)
7811 fun (name, style, _, flags, _, _, _) ->
7812 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7814 (match fst style with
7817 | RBool _ -> pr " int r;\n"
7818 | RInt64 _ -> pr " int64_t r;\n"
7819 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7820 | RString _ -> pr " char *r;\n"
7821 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7822 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7823 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7826 pr " size_t size;\n";
7832 | OptString n -> pr " const char *%s;\n" n
7836 | FileOut n -> pr " char *%s;\n" n
7838 pr " const char *%s;\n" n;
7839 pr " size_t %s_size;\n" n
7840 | StringList n | DeviceList n -> pr " char **%s;\n" n
7841 | Bool n -> pr " int %s;\n" n
7842 | Int n -> pr " int %s;\n" n
7843 | Int64 n -> pr " int64_t %s;\n" n
7846 (* Check and convert parameters. *)
7847 let argc_expected = List.length (snd style) in
7848 pr " if (argc != %d) {\n" argc_expected;
7849 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7851 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7855 let parse_integer fn fntyp rtyp range name i =
7857 pr " strtol_error xerr;\n";
7858 pr " %s r;\n" fntyp;
7860 pr " xerr = %s (argv[%d], NULL, 0, &r, xstrtol_suffixes);\n" fn i;
7861 pr " if (xerr != LONGINT_OK) {\n";
7862 pr " fprintf (stderr,\n";
7863 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7864 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7869 | Some (min, max, comment) ->
7870 pr " /* %s */\n" comment;
7871 pr " if (r < %s || r > %s) {\n" min max;
7872 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7876 pr " /* The check above should ensure this assignment does not overflow. */\n";
7878 pr " %s = r;\n" name;
7887 pr " %s = argv[%d];\n" name i
7889 | Dev_or_Path name ->
7890 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7891 pr " if (%s == NULL) return -1;\n" name
7893 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7896 pr " %s = argv[%d];\n" name i;
7897 pr " %s_size = strlen (argv[%d]);\n" name i
7899 pr " %s = file_in (argv[%d]);\n" name i;
7900 pr " if (%s == NULL) return -1;\n" name
7902 pr " %s = file_out (argv[%d]);\n" name i;
7903 pr " if (%s == NULL) return -1;\n" name
7904 | StringList name | DeviceList name ->
7905 pr " %s = parse_string_list (argv[%d]);\n" name i;
7906 pr " if (%s == NULL) return -1;\n" name;
7908 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7911 let min = "(-(2LL<<30))"
7912 and max = "((2LL<<30)-1)"
7914 "The Int type in the generator is a signed 31 bit int." in
7915 Some (min, max, comment) in
7916 parse_integer "xstrtoll" "long long" "int" range name i
7918 parse_integer "xstrtoll" "long long" "int64_t" None name i
7921 (* Call C API function. *)
7922 pr " r = guestfs_%s " name;
7923 generate_c_call_args ~handle:"g" style;
7928 | Device name | String name
7929 | OptString name | Bool name
7930 | Int name | Int64 name
7931 | BufferIn name -> ()
7932 | Pathname name | Dev_or_Path name | FileOut name ->
7933 pr " free (%s);\n" name
7935 pr " free_file_in (%s);\n" name
7936 | StringList name | DeviceList name ->
7937 pr " free_strings (%s);\n" name
7940 (* Any output flags? *)
7942 let flags = filter_map (
7943 function FishOutput flag -> Some flag | _ -> None
7949 failwithf "%s: more than one FishOutput flag is not allowed" name in
7951 (* Check return value for errors and display command results. *)
7952 (match fst style with
7953 | RErr -> pr " return r;\n"
7955 pr " if (r == -1) return -1;\n";
7956 (match fish_output with
7958 pr " printf (\"%%d\\n\", r);\n";
7959 | Some FishOutputOctal ->
7960 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7961 | Some FishOutputHexadecimal ->
7962 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7965 pr " if (r == -1) return -1;\n";
7966 (match fish_output with
7968 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7969 | Some FishOutputOctal ->
7970 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7971 | Some FishOutputHexadecimal ->
7972 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7975 pr " if (r == -1) return -1;\n";
7976 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7979 pr " if (r == NULL) return -1;\n";
7980 pr " printf (\"%%s\\n\", r);\n";
7982 | RConstOptString _ ->
7983 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7986 pr " if (r == NULL) return -1;\n";
7987 pr " printf (\"%%s\\n\", r);\n";
7991 pr " if (r == NULL) return -1;\n";
7992 pr " print_strings (r);\n";
7993 pr " free_strings (r);\n";
7995 | RStruct (_, typ) ->
7996 pr " if (r == NULL) return -1;\n";
7997 pr " print_%s (r);\n" typ;
7998 pr " guestfs_free_%s (r);\n" typ;
8000 | RStructList (_, typ) ->
8001 pr " if (r == NULL) return -1;\n";
8002 pr " print_%s_list (r);\n" typ;
8003 pr " guestfs_free_%s_list (r);\n" typ;
8006 pr " if (r == NULL) return -1;\n";
8007 pr " print_table (r);\n";
8008 pr " free_strings (r);\n";
8011 pr " if (r == NULL) return -1;\n";
8012 pr " if (full_write (1, r, size) != size) {\n";
8013 pr " perror (\"write\");\n";
8024 (* run_action function *)
8025 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
8028 fun (name, _, _, flags, _, _, _) ->
8029 let name2 = replace_char name '_' '-' in
8031 try find_map (function FishAlias n -> Some n | _ -> None) flags
8032 with Not_found -> name in
8034 pr "STRCASEEQ (cmd, \"%s\")" name;
8035 if name <> name2 then
8036 pr " || STRCASEEQ (cmd, \"%s\")" name2;
8037 if name <> alias then
8038 pr " || STRCASEEQ (cmd, \"%s\")" alias;
8040 pr " return run_%s (cmd, argc, argv);\n" name;
8044 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
8045 pr " if (command_num == 1)\n";
8046 pr " extended_help_message ();\n";
8053 (* Readline completion for guestfish. *)
8054 and generate_fish_completion () =
8055 generate_header CStyle GPLv2plus;
8059 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
8069 #ifdef HAVE_LIBREADLINE
8070 #include <readline/readline.h>
8075 #ifdef HAVE_LIBREADLINE
8077 static const char *const commands[] = {
8078 BUILTIN_COMMANDS_FOR_COMPLETION,
8081 (* Get the commands, including the aliases. They don't need to be
8082 * sorted - the generator() function just does a dumb linear search.
8086 fun (name, _, _, flags, _, _, _) ->
8087 let name2 = replace_char name '_' '-' in
8089 try find_map (function FishAlias n -> Some n | _ -> None) flags
8090 with Not_found -> name in
8092 if name <> alias then [name2; alias] else [name2]
8094 let commands = List.flatten commands in
8096 List.iter (pr " \"%s\",\n") commands;
8102 generator (const char *text, int state)
8104 static int index, len;
8109 len = strlen (text);
8112 rl_attempted_completion_over = 1;
8114 while ((name = commands[index]) != NULL) {
8116 if (STRCASEEQLEN (name, text, len))
8117 return strdup (name);
8123 #endif /* HAVE_LIBREADLINE */
8125 #ifdef HAVE_RL_COMPLETION_MATCHES
8126 #define RL_COMPLETION_MATCHES rl_completion_matches
8128 #ifdef HAVE_COMPLETION_MATCHES
8129 #define RL_COMPLETION_MATCHES completion_matches
8131 #endif /* else just fail if we don't have either symbol */
8134 do_completion (const char *text, int start, int end)
8136 char **matches = NULL;
8138 #ifdef HAVE_LIBREADLINE
8139 rl_completion_append_character = ' ';
8142 matches = RL_COMPLETION_MATCHES (text, generator);
8143 else if (complete_dest_paths)
8144 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
8151 (* Generate the POD documentation for guestfish. *)
8152 and generate_fish_actions_pod () =
8153 let all_functions_sorted =
8155 fun (_, _, _, flags, _, _, _) ->
8156 not (List.mem NotInFish flags || List.mem NotInDocs flags)
8157 ) all_functions_sorted in
8159 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8162 fun (name, style, _, flags, _, _, longdesc) ->
8164 Str.global_substitute rex (
8167 try Str.matched_group 1 s
8169 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8170 "C<" ^ replace_char sub '_' '-' ^ ">"
8172 let name = replace_char name '_' '-' in
8174 try find_map (function FishAlias n -> Some n | _ -> None) flags
8175 with Not_found -> name in
8177 pr "=head2 %s" name;
8178 if name <> alias then
8185 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
8186 | OptString n -> pr " %s" n
8187 | StringList n | DeviceList n -> pr " '%s ...'" n
8188 | Bool _ -> pr " true|false"
8189 | Int n -> pr " %s" n
8190 | Int64 n -> pr " %s" n
8191 | FileIn n | FileOut n -> pr " (%s|-)" n
8192 | BufferIn n -> pr " %s" n
8196 pr "%s\n\n" longdesc;
8198 if List.exists (function FileIn _ | FileOut _ -> true
8199 | _ -> false) (snd style) then
8200 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8202 if List.mem ProtocolLimitWarning flags then
8203 pr "%s\n\n" protocol_limit_warning;
8205 if List.mem DangerWillRobinson flags then
8206 pr "%s\n\n" danger_will_robinson;
8208 match deprecation_notice flags with
8210 | Some txt -> pr "%s\n\n" txt
8211 ) all_functions_sorted
8213 (* Generate a C function prototype. *)
8214 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8215 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8217 ?handle name style =
8218 if extern then pr "extern ";
8219 if static then pr "static ";
8220 (match fst style with
8222 | RInt _ -> pr "int "
8223 | RInt64 _ -> pr "int64_t "
8224 | RBool _ -> pr "int "
8225 | RConstString _ | RConstOptString _ -> pr "const char *"
8226 | RString _ | RBufferOut _ -> pr "char *"
8227 | RStringList _ | RHashtable _ -> pr "char **"
8228 | RStruct (_, typ) ->
8229 if not in_daemon then pr "struct guestfs_%s *" typ
8230 else pr "guestfs_int_%s *" typ
8231 | RStructList (_, typ) ->
8232 if not in_daemon then pr "struct guestfs_%s_list *" typ
8233 else pr "guestfs_int_%s_list *" typ
8235 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8236 pr "%s%s (" prefix name;
8237 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8240 let comma = ref false in
8243 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8247 if single_line then pr ", " else pr ",\n\t\t"
8254 | Device n | Dev_or_Path n
8258 pr "const char *%s" n
8259 | StringList n | DeviceList n ->
8261 pr "char *const *%s" n
8262 | Bool n -> next (); pr "int %s" n
8263 | Int n -> next (); pr "int %s" n
8264 | Int64 n -> next (); pr "int64_t %s" n
8267 if not in_daemon then (next (); pr "const char *%s" n)
8270 pr "const char *%s" n;
8272 pr "size_t %s_size" n
8274 if is_RBufferOut then (next (); pr "size_t *size_r");
8277 if semicolon then pr ";";
8278 if newline then pr "\n"
8280 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8281 and generate_c_call_args ?handle ?(decl = false) style =
8283 let comma = ref false in
8285 if !comma then pr ", ";
8290 | Some handle -> pr "%s" handle; comma := true
8296 pr "%s, %s_size" n n
8299 pr "%s" (name_of_argt arg)
8301 (* For RBufferOut calls, add implicit &size parameter. *)
8303 match fst style with
8311 (* Generate the OCaml bindings interface. *)
8312 and generate_ocaml_mli () =
8313 generate_header OCamlStyle LGPLv2plus;
8316 (** For API documentation you should refer to the C API
8317 in the guestfs(3) manual page. The OCaml API uses almost
8318 exactly the same calls. *)
8321 (** A [guestfs_h] handle. *)
8323 exception Error of string
8324 (** This exception is raised when there is an error. *)
8326 exception Handle_closed of string
8327 (** This exception is raised if you use a {!Guestfs.t} handle
8328 after calling {!close} on it. The string is the name of
8331 val create : unit -> t
8332 (** Create a {!Guestfs.t} handle. *)
8334 val close : t -> unit
8335 (** Close the {!Guestfs.t} handle and free up all resources used
8338 Handles are closed by the garbage collector when they become
8339 unreferenced, but callers can call this in order to provide
8340 predictable cleanup. *)
8343 generate_ocaml_structure_decls ();
8347 fun (name, style, _, _, _, shortdesc, _) ->
8348 generate_ocaml_prototype name style;
8349 pr "(** %s *)\n" shortdesc;
8351 ) all_functions_sorted
8353 (* Generate the OCaml bindings implementation. *)
8354 and generate_ocaml_ml () =
8355 generate_header OCamlStyle LGPLv2plus;
8360 exception Error of string
8361 exception Handle_closed of string
8363 external create : unit -> t = \"ocaml_guestfs_create\"
8364 external close : t -> unit = \"ocaml_guestfs_close\"
8366 (* Give the exceptions names, so they can be raised from the C code. *)
8368 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8369 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8373 generate_ocaml_structure_decls ();
8377 fun (name, style, _, _, _, shortdesc, _) ->
8378 generate_ocaml_prototype ~is_external:true name style;
8379 ) all_functions_sorted
8381 (* Generate the OCaml bindings C implementation. *)
8382 and generate_ocaml_c () =
8383 generate_header CStyle LGPLv2plus;
8390 #include <caml/config.h>
8391 #include <caml/alloc.h>
8392 #include <caml/callback.h>
8393 #include <caml/fail.h>
8394 #include <caml/memory.h>
8395 #include <caml/mlvalues.h>
8396 #include <caml/signals.h>
8398 #include <guestfs.h>
8400 #include \"guestfs_c.h\"
8402 /* Copy a hashtable of string pairs into an assoc-list. We return
8403 * the list in reverse order, but hashtables aren't supposed to be
8406 static CAMLprim value
8407 copy_table (char * const * argv)
8410 CAMLlocal5 (rv, pairv, kv, vv, cons);
8414 for (i = 0; argv[i] != NULL; i += 2) {
8415 kv = caml_copy_string (argv[i]);
8416 vv = caml_copy_string (argv[i+1]);
8417 pairv = caml_alloc (2, 0);
8418 Store_field (pairv, 0, kv);
8419 Store_field (pairv, 1, vv);
8420 cons = caml_alloc (2, 0);
8421 Store_field (cons, 1, rv);
8423 Store_field (cons, 0, pairv);
8431 (* Struct copy functions. *)
8433 let emit_ocaml_copy_list_function typ =
8434 pr "static CAMLprim value\n";
8435 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8437 pr " CAMLparam0 ();\n";
8438 pr " CAMLlocal2 (rv, v);\n";
8439 pr " unsigned int i;\n";
8441 pr " if (%ss->len == 0)\n" typ;
8442 pr " CAMLreturn (Atom (0));\n";
8444 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8445 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8446 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8447 pr " caml_modify (&Field (rv, i), v);\n";
8449 pr " CAMLreturn (rv);\n";
8457 let has_optpercent_col =
8458 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8460 pr "static CAMLprim value\n";
8461 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8463 pr " CAMLparam0 ();\n";
8464 if has_optpercent_col then
8465 pr " CAMLlocal3 (rv, v, v2);\n"
8467 pr " CAMLlocal2 (rv, v);\n";
8469 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8474 pr " v = caml_copy_string (%s->%s);\n" typ name
8476 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8477 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8480 pr " v = caml_alloc_string (32);\n";
8481 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8482 | name, (FBytes|FInt64|FUInt64) ->
8483 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8484 | name, (FInt32|FUInt32) ->
8485 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8486 | name, FOptPercent ->
8487 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8488 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8489 pr " v = caml_alloc (1, 0);\n";
8490 pr " Store_field (v, 0, v2);\n";
8491 pr " } else /* None */\n";
8492 pr " v = Val_int (0);\n";
8494 pr " v = Val_int (%s->%s);\n" typ name
8496 pr " Store_field (rv, %d, v);\n" i
8498 pr " CAMLreturn (rv);\n";
8503 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8506 | typ, (RStructListOnly | RStructAndList) ->
8507 (* generate the function for typ *)
8508 emit_ocaml_copy_list_function typ
8509 | typ, _ -> () (* empty *)
8510 ) (rstructs_used_by all_functions);
8514 fun (name, style, _, _, _, _, _) ->
8515 pr "/* Automatically generated wrapper for function\n";
8517 generate_ocaml_prototype name style;
8522 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8524 let needs_extra_vs =
8525 match fst style with RConstOptString _ -> true | _ -> false in
8527 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8528 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8529 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8532 pr "CAMLprim value\n";
8533 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8534 List.iter (pr ", value %s") (List.tl params);
8539 | [p1; p2; p3; p4; p5] ->
8540 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8541 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8542 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8543 pr " CAMLxparam%d (%s);\n"
8544 (List.length rest) (String.concat ", " rest)
8546 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8548 if not needs_extra_vs then
8549 pr " CAMLlocal1 (rv);\n"
8551 pr " CAMLlocal3 (rv, v, v2);\n";
8554 pr " guestfs_h *g = Guestfs_val (gv);\n";
8555 pr " if (g == NULL)\n";
8556 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8562 | Device n | Dev_or_Path n
8566 pr " const char *%s = String_val (%sv);\n" n n
8568 pr " const char *%s =\n" n;
8569 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8572 pr " const char *%s = String_val (%sv);\n" n n;
8573 pr " size_t %s_size = caml_string_length (%sv);\n" n n
8574 | StringList n | DeviceList n ->
8575 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8577 pr " int %s = Bool_val (%sv);\n" n n
8579 pr " int %s = Int_val (%sv);\n" n n
8581 pr " int64_t %s = Int64_val (%sv);\n" n n
8584 match fst style with
8585 | RErr -> pr " int r;\n"; "-1"
8586 | RInt _ -> pr " int r;\n"; "-1"
8587 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8588 | RBool _ -> pr " int r;\n"; "-1"
8589 | RConstString _ | RConstOptString _ ->
8590 pr " const char *r;\n"; "NULL"
8591 | RString _ -> pr " char *r;\n"; "NULL"
8596 | RStruct (_, typ) ->
8597 pr " struct guestfs_%s *r;\n" typ; "NULL"
8598 | RStructList (_, typ) ->
8599 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8606 pr " size_t size;\n";
8610 pr " caml_enter_blocking_section ();\n";
8611 pr " r = guestfs_%s " name;
8612 generate_c_call_args ~handle:"g" style;
8614 pr " caml_leave_blocking_section ();\n";
8618 | StringList n | DeviceList n ->
8619 pr " ocaml_guestfs_free_strings (%s);\n" n;
8620 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8621 | Bool _ | Int _ | Int64 _
8622 | FileIn _ | FileOut _ | BufferIn _ -> ()
8625 pr " if (r == %s)\n" error_code;
8626 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8629 (match fst style with
8630 | RErr -> pr " rv = Val_unit;\n"
8631 | RInt _ -> pr " rv = Val_int (r);\n"
8633 pr " rv = caml_copy_int64 (r);\n"
8634 | RBool _ -> pr " rv = Val_bool (r);\n"
8636 pr " rv = caml_copy_string (r);\n"
8637 | RConstOptString _ ->
8638 pr " if (r) { /* Some string */\n";
8639 pr " v = caml_alloc (1, 0);\n";
8640 pr " v2 = caml_copy_string (r);\n";
8641 pr " Store_field (v, 0, v2);\n";
8642 pr " } else /* None */\n";
8643 pr " v = Val_int (0);\n";
8645 pr " rv = caml_copy_string (r);\n";
8648 pr " rv = caml_copy_string_array ((const char **) r);\n";
8649 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8651 | RStruct (_, typ) ->
8652 pr " rv = copy_%s (r);\n" typ;
8653 pr " guestfs_free_%s (r);\n" typ;
8654 | RStructList (_, typ) ->
8655 pr " rv = copy_%s_list (r);\n" typ;
8656 pr " guestfs_free_%s_list (r);\n" typ;
8658 pr " rv = copy_table (r);\n";
8659 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8662 pr " rv = caml_alloc_string (size);\n";
8663 pr " memcpy (String_val (rv), r, size);\n";
8666 pr " CAMLreturn (rv);\n";
8670 if List.length params > 5 then (
8671 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8672 pr "CAMLprim value ";
8673 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8674 pr "CAMLprim value\n";
8675 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8677 pr " return ocaml_guestfs_%s (argv[0]" name;
8678 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8683 ) all_functions_sorted
8685 and generate_ocaml_structure_decls () =
8688 pr "type %s = {\n" typ;
8691 | name, FString -> pr " %s : string;\n" name
8692 | name, FBuffer -> pr " %s : string;\n" name
8693 | name, FUUID -> pr " %s : string;\n" name
8694 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8695 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8696 | name, FChar -> pr " %s : char;\n" name
8697 | name, FOptPercent -> pr " %s : float option;\n" name
8703 and generate_ocaml_prototype ?(is_external = false) name style =
8704 if is_external then pr "external " else pr "val ";
8705 pr "%s : t -> " name;
8708 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8709 | BufferIn _ -> pr "string -> "
8710 | OptString _ -> pr "string option -> "
8711 | StringList _ | DeviceList _ -> pr "string array -> "
8712 | Bool _ -> pr "bool -> "
8713 | Int _ -> pr "int -> "
8714 | Int64 _ -> pr "int64 -> "
8716 (match fst style with
8717 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8718 | RInt _ -> pr "int"
8719 | RInt64 _ -> pr "int64"
8720 | RBool _ -> pr "bool"
8721 | RConstString _ -> pr "string"
8722 | RConstOptString _ -> pr "string option"
8723 | RString _ | RBufferOut _ -> pr "string"
8724 | RStringList _ -> pr "string array"
8725 | RStruct (_, typ) -> pr "%s" typ
8726 | RStructList (_, typ) -> pr "%s array" typ
8727 | RHashtable _ -> pr "(string * string) list"
8729 if is_external then (
8731 if List.length (snd style) + 1 > 5 then
8732 pr "\"ocaml_guestfs_%s_byte\" " name;
8733 pr "\"ocaml_guestfs_%s\"" name
8737 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8738 and generate_perl_xs () =
8739 generate_header CStyle LGPLv2plus;
8742 #include \"EXTERN.h\"
8746 #include <guestfs.h>
8749 #define PRId64 \"lld\"
8753 my_newSVll(long long val) {
8754 #ifdef USE_64_BIT_ALL
8755 return newSViv(val);
8759 len = snprintf(buf, 100, \"%%\" PRId64, val);
8760 return newSVpv(buf, len);
8765 #define PRIu64 \"llu\"
8769 my_newSVull(unsigned long long val) {
8770 #ifdef USE_64_BIT_ALL
8771 return newSVuv(val);
8775 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8776 return newSVpv(buf, len);
8780 /* http://www.perlmonks.org/?node_id=680842 */
8782 XS_unpack_charPtrPtr (SV *arg) {
8787 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8788 croak (\"array reference expected\");
8790 av = (AV *)SvRV (arg);
8791 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8793 croak (\"malloc failed\");
8795 for (i = 0; i <= av_len (av); i++) {
8796 SV **elem = av_fetch (av, i, 0);
8798 if (!elem || !*elem)
8799 croak (\"missing element in list\");
8801 ret[i] = SvPV_nolen (*elem);
8809 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8816 RETVAL = guestfs_create ();
8818 croak (\"could not create guestfs handle\");
8819 guestfs_set_error_handler (RETVAL, NULL, NULL);
8827 /* For the 'g' argument above we do the conversion explicitly and
8828 * don't rely on the typemap, because if the handle has been
8829 * explicitly closed we don't want the typemap conversion to
8832 HV *hv = (HV *) SvRV (sv);
8833 SV **svp = hv_fetch (hv, \"_g\", 2, 0);
8835 guestfs_h *g = (guestfs_h *) SvIV (*svp);
8845 /* Avoid double-free in DESTROY method. */
8846 HV *hv = (HV *) SvRV (ST(0));
8847 (void) hv_delete (hv, \"_g\", 2, G_DISCARD);
8852 fun (name, style, _, _, _, _, _) ->
8853 (match fst style with
8854 | RErr -> pr "void\n"
8855 | RInt _ -> pr "SV *\n"
8856 | RInt64 _ -> pr "SV *\n"
8857 | RBool _ -> pr "SV *\n"
8858 | RConstString _ -> pr "SV *\n"
8859 | RConstOptString _ -> pr "SV *\n"
8860 | RString _ -> pr "SV *\n"
8861 | RBufferOut _ -> pr "SV *\n"
8863 | RStruct _ | RStructList _
8865 pr "void\n" (* all lists returned implictly on the stack *)
8867 (* Call and arguments. *)
8870 fun arg -> pr ", %s" (name_of_argt arg)
8873 pr " guestfs_h *g;\n";
8877 | Pathname n | Device n | Dev_or_Path n | String n
8878 | FileIn n | FileOut n ->
8881 pr " char *%s;\n" n;
8882 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
8884 (* http://www.perlmonks.org/?node_id=554277
8885 * Note that the implicit handle argument means we have
8886 * to add 1 to the ST(x) operator.
8888 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8889 | StringList n | DeviceList n -> pr " char **%s;\n" n
8890 | Bool n -> pr " int %s;\n" n
8891 | Int n -> pr " int %s;\n" n
8892 | Int64 n -> pr " int64_t %s;\n" n
8895 let do_cleanups () =
8898 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8899 | Bool _ | Int _ | Int64 _
8900 | FileIn _ | FileOut _
8902 | StringList n | DeviceList n -> pr " free (%s);\n" n
8907 (match fst style with
8912 pr " r = guestfs_%s " name;
8913 generate_c_call_args ~handle:"g" style;
8916 pr " if (r == -1)\n";
8917 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8923 pr " %s = guestfs_%s " n name;
8924 generate_c_call_args ~handle:"g" style;
8927 pr " if (%s == -1)\n" n;
8928 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8929 pr " RETVAL = newSViv (%s);\n" n;
8934 pr " int64_t %s;\n" n;
8936 pr " %s = guestfs_%s " n name;
8937 generate_c_call_args ~handle:"g" style;
8940 pr " if (%s == -1)\n" n;
8941 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8942 pr " RETVAL = my_newSVll (%s);\n" n;
8947 pr " const char *%s;\n" n;
8949 pr " %s = guestfs_%s " n name;
8950 generate_c_call_args ~handle:"g" style;
8953 pr " if (%s == NULL)\n" n;
8954 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8955 pr " RETVAL = newSVpv (%s, 0);\n" n;
8958 | RConstOptString n ->
8960 pr " const char *%s;\n" n;
8962 pr " %s = guestfs_%s " n name;
8963 generate_c_call_args ~handle:"g" style;
8966 pr " if (%s == NULL)\n" n;
8967 pr " RETVAL = &PL_sv_undef;\n";
8969 pr " RETVAL = newSVpv (%s, 0);\n" n;
8974 pr " char *%s;\n" 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 = newSVpv (%s, 0);\n" n;
8983 pr " free (%s);\n" n;
8986 | RStringList n | RHashtable n ->
8988 pr " char **%s;\n" n;
8991 pr " %s = guestfs_%s " n name;
8992 generate_c_call_args ~handle:"g" style;
8995 pr " if (%s == NULL)\n" n;
8996 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8997 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8998 pr " EXTEND (SP, n);\n";
8999 pr " for (i = 0; i < n; ++i) {\n";
9000 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
9001 pr " free (%s[i]);\n" n;
9003 pr " free (%s);\n" n;
9004 | RStruct (n, typ) ->
9005 let cols = cols_of_struct typ in
9006 generate_perl_struct_code typ cols name style n do_cleanups
9007 | RStructList (n, typ) ->
9008 let cols = cols_of_struct typ in
9009 generate_perl_struct_list_code typ cols name style n do_cleanups
9012 pr " char *%s;\n" n;
9013 pr " size_t size;\n";
9015 pr " %s = guestfs_%s " n name;
9016 generate_c_call_args ~handle:"g" style;
9019 pr " if (%s == NULL)\n" n;
9020 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9021 pr " RETVAL = newSVpvn (%s, size);\n" n;
9022 pr " free (%s);\n" n;
9030 and generate_perl_struct_list_code typ cols name style n do_cleanups =
9032 pr " struct guestfs_%s_list *%s;\n" typ n;
9036 pr " %s = guestfs_%s " n name;
9037 generate_c_call_args ~handle:"g" style;
9040 pr " if (%s == NULL)\n" n;
9041 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9042 pr " EXTEND (SP, %s->len);\n" n;
9043 pr " for (i = 0; i < %s->len; ++i) {\n" n;
9044 pr " hv = newHV ();\n";
9048 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
9049 name (String.length name) n name
9051 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
9052 name (String.length name) n name
9054 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
9055 name (String.length name) n name n name
9056 | name, (FBytes|FUInt64) ->
9057 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
9058 name (String.length name) n name
9060 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
9061 name (String.length name) n name
9062 | name, (FInt32|FUInt32) ->
9063 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9064 name (String.length name) n name
9066 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
9067 name (String.length name) n name
9068 | name, FOptPercent ->
9069 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
9070 name (String.length name) n name
9072 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
9074 pr " guestfs_free_%s_list (%s);\n" typ n
9076 and generate_perl_struct_code typ cols name style n do_cleanups =
9078 pr " struct guestfs_%s *%s;\n" typ n;
9080 pr " %s = guestfs_%s " n name;
9081 generate_c_call_args ~handle:"g" style;
9084 pr " if (%s == NULL)\n" n;
9085 pr " croak (\"%%s\", guestfs_last_error (g));\n";
9086 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
9088 fun ((name, _) as col) ->
9089 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
9093 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
9096 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
9099 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
9101 | name, (FBytes|FUInt64) ->
9102 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
9105 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
9107 | name, (FInt32|FUInt32) ->
9108 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9111 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
9113 | name, FOptPercent ->
9114 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
9117 pr " free (%s);\n" n
9119 (* Generate Sys/Guestfs.pm. *)
9120 and generate_perl_pm () =
9121 generate_header HashStyle LGPLv2plus;
9128 Sys::Guestfs - Perl bindings for libguestfs
9134 my $h = Sys::Guestfs->new ();
9135 $h->add_drive ('guest.img');
9137 $h->mount ('/dev/sda1', '/');
9138 $h->touch ('/hello');
9143 The C<Sys::Guestfs> module provides a Perl XS binding to the
9144 libguestfs API for examining and modifying virtual machine
9147 Amongst the things this is good for: making batch configuration
9148 changes to guests, getting disk used/free statistics (see also:
9149 virt-df), migrating between virtualization systems (see also:
9150 virt-p2v), performing partial backups, performing partial guest
9151 clones, cloning guests and changing registry/UUID/hostname info, and
9154 Libguestfs uses Linux kernel and qemu code, and can access any type of
9155 guest filesystem that Linux and qemu can, including but not limited
9156 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9157 schemes, qcow, qcow2, vmdk.
9159 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9160 LVs, what filesystem is in each LV, etc.). It can also run commands
9161 in the context of the guest. Also you can access filesystems over
9164 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
9165 functions for using libguestfs from Perl, including integration
9170 All errors turn into calls to C<croak> (see L<Carp(3)>).
9178 package Sys::Guestfs;
9183 # This version number changes whenever a new function
9184 # is added to the libguestfs API. It is not directly
9185 # related to the libguestfs version number.
9186 use vars qw($VERSION);
9190 XSLoader::load ('Sys::Guestfs');
9192 =item $h = Sys::Guestfs->new ();
9194 Create a new guestfs handle.
9200 my $class = ref ($proto) || $proto;
9202 my $g = Sys::Guestfs::_create ();
9203 my $self = { _g => $g };
9204 bless $self, $class;
9210 Explicitly close the guestfs handle.
9212 B<Note:> You should not usually call this function. The handle will
9213 be closed implicitly when its reference count goes to zero (eg.
9214 when it goes out of scope or the program ends). This call is
9215 only required in some exceptional cases, such as where the program
9216 may contain cached references to the handle 'somewhere' and you
9217 really have to have the close happen right away. After calling
9218 C<close> the program must not call any method (including C<close>)
9219 on the handle (but the implicit call to C<DESTROY> that happens
9220 when the final reference is cleaned up is OK).
9226 (* Actions. We only need to print documentation for these as
9227 * they are pulled in from the XS code automatically.
9230 fun (name, style, _, flags, _, _, longdesc) ->
9231 if not (List.mem NotInDocs flags) then (
9232 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9234 generate_perl_prototype name style;
9236 pr "%s\n\n" longdesc;
9237 if List.mem ProtocolLimitWarning flags then
9238 pr "%s\n\n" protocol_limit_warning;
9239 if List.mem DangerWillRobinson flags then
9240 pr "%s\n\n" danger_will_robinson;
9241 match deprecation_notice flags with
9243 | Some txt -> pr "%s\n\n" txt
9245 ) all_functions_sorted;
9257 Copyright (C) %s Red Hat Inc.
9261 Please see the file COPYING.LIB for the full license.
9267 L<http://libguestfs.org>,
9268 L<Sys::Guestfs::Lib(3)>.
9273 and generate_perl_prototype name style =
9274 (match fst style with
9282 | RBufferOut n -> pr "$%s = " n
9284 | RHashtable n -> pr "%%%s = " n
9286 | RStructList (n,_) -> pr "@%s = " n
9289 let comma = ref false in
9292 if !comma then pr ", ";
9295 | Pathname n | Device n | Dev_or_Path n | String n
9296 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9299 | StringList n | DeviceList n ->
9304 (* Generate Python C module. *)
9305 and generate_python_c () =
9306 generate_header CStyle LGPLv2plus;
9309 #define PY_SSIZE_T_CLEAN 1
9312 #if PY_VERSION_HEX < 0x02050000
9313 typedef int Py_ssize_t;
9314 #define PY_SSIZE_T_MAX INT_MAX
9315 #define PY_SSIZE_T_MIN INT_MIN
9322 #include \"guestfs.h\"
9330 get_handle (PyObject *obj)
9333 assert (obj != Py_None);
9334 return ((Pyguestfs_Object *) obj)->g;
9338 put_handle (guestfs_h *g)
9342 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9345 /* This list should be freed (but not the strings) after use. */
9347 get_string_list (PyObject *obj)
9354 if (!PyList_Check (obj)) {
9355 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9359 len = PyList_Size (obj);
9360 r = malloc (sizeof (char *) * (len+1));
9362 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9366 for (i = 0; i < len; ++i)
9367 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9374 put_string_list (char * const * const argv)
9379 for (argc = 0; argv[argc] != NULL; ++argc)
9382 list = PyList_New (argc);
9383 for (i = 0; i < argc; ++i)
9384 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9390 put_table (char * const * const argv)
9392 PyObject *list, *item;
9395 for (argc = 0; argv[argc] != NULL; ++argc)
9398 list = PyList_New (argc >> 1);
9399 for (i = 0; i < argc; i += 2) {
9400 item = PyTuple_New (2);
9401 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9402 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9403 PyList_SetItem (list, i >> 1, item);
9410 free_strings (char **argv)
9414 for (argc = 0; argv[argc] != NULL; ++argc)
9420 py_guestfs_create (PyObject *self, PyObject *args)
9424 g = guestfs_create ();
9426 PyErr_SetString (PyExc_RuntimeError,
9427 \"guestfs.create: failed to allocate handle\");
9430 guestfs_set_error_handler (g, NULL, NULL);
9431 return put_handle (g);
9435 py_guestfs_close (PyObject *self, PyObject *args)
9440 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9442 g = get_handle (py_g);
9446 Py_INCREF (Py_None);
9452 let emit_put_list_function typ =
9453 pr "static PyObject *\n";
9454 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9456 pr " PyObject *list;\n";
9459 pr " list = PyList_New (%ss->len);\n" typ;
9460 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9461 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9462 pr " return list;\n";
9467 (* Structures, turned into Python dictionaries. *)
9470 pr "static PyObject *\n";
9471 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9473 pr " PyObject *dict;\n";
9475 pr " dict = PyDict_New ();\n";
9479 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9480 pr " PyString_FromString (%s->%s));\n"
9483 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9484 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9487 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9488 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9490 | name, (FBytes|FUInt64) ->
9491 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9492 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9495 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9496 pr " PyLong_FromLongLong (%s->%s));\n"
9499 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9500 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9503 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9504 pr " PyLong_FromLong (%s->%s));\n"
9506 | name, FOptPercent ->
9507 pr " if (%s->%s >= 0)\n" typ name;
9508 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9509 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9512 pr " Py_INCREF (Py_None);\n";
9513 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9516 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9517 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9519 pr " return dict;\n";
9525 (* Emit a put_TYPE_list function definition only if that function is used. *)
9528 | typ, (RStructListOnly | RStructAndList) ->
9529 (* generate the function for typ *)
9530 emit_put_list_function typ
9531 | typ, _ -> () (* empty *)
9532 ) (rstructs_used_by all_functions);
9534 (* Python wrapper functions. *)
9536 fun (name, style, _, _, _, _, _) ->
9537 pr "static PyObject *\n";
9538 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9541 pr " PyObject *py_g;\n";
9542 pr " guestfs_h *g;\n";
9543 pr " PyObject *py_r;\n";
9546 match fst style with
9547 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9548 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9549 | RConstString _ | RConstOptString _ ->
9550 pr " const char *r;\n"; "NULL"
9551 | RString _ -> pr " char *r;\n"; "NULL"
9552 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9553 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9554 | RStructList (_, typ) ->
9555 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9558 pr " size_t size;\n";
9563 | Pathname n | Device n | Dev_or_Path n | String n
9564 | FileIn n | FileOut n ->
9565 pr " const char *%s;\n" n
9566 | OptString n -> pr " const char *%s;\n" n
9568 pr " const char *%s;\n" n;
9569 pr " Py_ssize_t %s_size;\n" n
9570 | StringList n | DeviceList n ->
9571 pr " PyObject *py_%s;\n" n;
9572 pr " char **%s;\n" n
9573 | Bool n -> pr " int %s;\n" n
9574 | Int n -> pr " int %s;\n" n
9575 | Int64 n -> pr " long long %s;\n" n
9580 (* Convert the parameters. *)
9581 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9584 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9585 | OptString _ -> pr "z"
9586 | StringList _ | DeviceList _ -> pr "O"
9587 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9589 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9590 * emulate C's int/long/long long in Python?
9592 | BufferIn _ -> pr "s#"
9594 pr ":guestfs_%s\",\n" name;
9598 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9599 | OptString n -> pr ", &%s" n
9600 | StringList n | DeviceList n -> pr ", &py_%s" n
9601 | Bool n -> pr ", &%s" n
9602 | Int n -> pr ", &%s" n
9603 | Int64 n -> pr ", &%s" n
9604 | BufferIn n -> pr ", &%s, &%s_size" n n
9608 pr " return NULL;\n";
9610 pr " g = get_handle (py_g);\n";
9613 | Pathname _ | Device _ | Dev_or_Path _ | String _
9614 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9616 | StringList n | DeviceList n ->
9617 pr " %s = get_string_list (py_%s);\n" n n;
9618 pr " if (!%s) return NULL;\n" n
9623 pr " r = guestfs_%s " name;
9624 generate_c_call_args ~handle:"g" style;
9629 | Pathname _ | Device _ | Dev_or_Path _ | String _
9630 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9632 | StringList n | DeviceList n ->
9633 pr " free (%s);\n" n
9636 pr " if (r == %s) {\n" error_code;
9637 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9638 pr " return NULL;\n";
9642 (match fst style with
9644 pr " Py_INCREF (Py_None);\n";
9645 pr " py_r = Py_None;\n"
9647 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9648 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9649 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9650 | RConstOptString _ ->
9652 pr " py_r = PyString_FromString (r);\n";
9654 pr " Py_INCREF (Py_None);\n";
9655 pr " py_r = Py_None;\n";
9658 pr " py_r = PyString_FromString (r);\n";
9661 pr " py_r = put_string_list (r);\n";
9662 pr " free_strings (r);\n"
9663 | RStruct (_, typ) ->
9664 pr " py_r = put_%s (r);\n" typ;
9665 pr " guestfs_free_%s (r);\n" typ
9666 | RStructList (_, typ) ->
9667 pr " py_r = put_%s_list (r);\n" typ;
9668 pr " guestfs_free_%s_list (r);\n" typ
9670 pr " py_r = put_table (r);\n";
9671 pr " free_strings (r);\n"
9673 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9677 pr " return py_r;\n";
9682 (* Table of functions. *)
9683 pr "static PyMethodDef methods[] = {\n";
9684 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9685 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9687 fun (name, _, _, _, _, _, _) ->
9688 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9691 pr " { NULL, NULL, 0, NULL }\n";
9695 (* Init function. *)
9698 initlibguestfsmod (void)
9700 static int initialized = 0;
9702 if (initialized) return;
9703 Py_InitModule ((char *) \"libguestfsmod\", methods);
9708 (* Generate Python module. *)
9709 and generate_python_py () =
9710 generate_header HashStyle LGPLv2plus;
9713 u\"\"\"Python bindings for libguestfs
9716 g = guestfs.GuestFS ()
9717 g.add_drive (\"guest.img\")
9719 parts = g.list_partitions ()
9721 The guestfs module provides a Python binding to the libguestfs API
9722 for examining and modifying virtual machine disk images.
9724 Amongst the things this is good for: making batch configuration
9725 changes to guests, getting disk used/free statistics (see also:
9726 virt-df), migrating between virtualization systems (see also:
9727 virt-p2v), performing partial backups, performing partial guest
9728 clones, cloning guests and changing registry/UUID/hostname info, and
9731 Libguestfs uses Linux kernel and qemu code, and can access any type of
9732 guest filesystem that Linux and qemu can, including but not limited
9733 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9734 schemes, qcow, qcow2, vmdk.
9736 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9737 LVs, what filesystem is in each LV, etc.). It can also run commands
9738 in the context of the guest. Also you can access filesystems over
9741 Errors which happen while using the API are turned into Python
9742 RuntimeError exceptions.
9744 To create a guestfs handle you usually have to perform the following
9747 # Create the handle, call add_drive at least once, and possibly
9748 # several times if the guest has multiple block devices:
9749 g = guestfs.GuestFS ()
9750 g.add_drive (\"guest.img\")
9752 # Launch the qemu subprocess and wait for it to become ready:
9755 # Now you can issue commands, for example:
9760 import libguestfsmod
9763 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9765 def __init__ (self):
9766 \"\"\"Create a new libguestfs handle.\"\"\"
9767 self._o = libguestfsmod.create ()
9770 libguestfsmod.close (self._o)
9775 fun (name, style, _, flags, _, _, longdesc) ->
9777 generate_py_call_args ~handle:"self" (snd style);
9780 if not (List.mem NotInDocs flags) then (
9781 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9783 match fst style with
9784 | RErr | RInt _ | RInt64 _ | RBool _
9785 | RConstOptString _ | RConstString _
9786 | RString _ | RBufferOut _ -> doc
9788 doc ^ "\n\nThis function returns a list of strings."
9789 | RStruct (_, typ) ->
9790 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9791 | RStructList (_, typ) ->
9792 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9794 doc ^ "\n\nThis function returns a dictionary." in
9796 if List.mem ProtocolLimitWarning flags then
9797 doc ^ "\n\n" ^ protocol_limit_warning
9800 if List.mem DangerWillRobinson flags then
9801 doc ^ "\n\n" ^ danger_will_robinson
9804 match deprecation_notice flags with
9806 | Some txt -> doc ^ "\n\n" ^ txt in
9807 let doc = pod2text ~width:60 name doc in
9808 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9809 let doc = String.concat "\n " doc in
9810 pr " u\"\"\"%s\"\"\"\n" doc;
9812 pr " return libguestfsmod.%s " name;
9813 generate_py_call_args ~handle:"self._o" (snd style);
9818 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9819 and generate_py_call_args ~handle args =
9821 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9824 (* Useful if you need the longdesc POD text as plain text. Returns a
9827 * Because this is very slow (the slowest part of autogeneration),
9828 * we memoize the results.
9830 and pod2text ~width name longdesc =
9831 let key = width, name, longdesc in
9832 try Hashtbl.find pod2text_memo key
9834 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9835 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9837 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9838 let chan = open_process_in cmd in
9839 let lines = ref [] in
9841 let line = input_line chan in
9842 if i = 1 then (* discard the first line of output *)
9845 let line = triml line in
9846 lines := line :: !lines;
9849 let lines = try loop 1 with End_of_file -> List.rev !lines in
9851 (match close_process_in chan with
9854 failwithf "pod2text: process exited with non-zero status (%d)" i
9855 | WSIGNALED i | WSTOPPED i ->
9856 failwithf "pod2text: process signalled or stopped by signal %d" i
9858 Hashtbl.add pod2text_memo key lines;
9859 pod2text_memo_updated ();
9862 (* Generate ruby bindings. *)
9863 and generate_ruby_c () =
9864 generate_header CStyle LGPLv2plus;
9872 #include \"guestfs.h\"
9874 #include \"extconf.h\"
9876 /* For Ruby < 1.9 */
9878 #define RARRAY_LEN(r) (RARRAY((r))->len)
9881 static VALUE m_guestfs; /* guestfs module */
9882 static VALUE c_guestfs; /* guestfs_h handle */
9883 static VALUE e_Error; /* used for all errors */
9885 static void ruby_guestfs_free (void *p)
9888 guestfs_close ((guestfs_h *) p);
9891 static VALUE ruby_guestfs_create (VALUE m)
9895 g = guestfs_create ();
9897 rb_raise (e_Error, \"failed to create guestfs handle\");
9899 /* Don't print error messages to stderr by default. */
9900 guestfs_set_error_handler (g, NULL, NULL);
9902 /* Wrap it, and make sure the close function is called when the
9905 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9908 static VALUE ruby_guestfs_close (VALUE gv)
9911 Data_Get_Struct (gv, guestfs_h, g);
9913 ruby_guestfs_free (g);
9914 DATA_PTR (gv) = NULL;
9922 fun (name, style, _, _, _, _, _) ->
9923 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9924 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9927 pr " guestfs_h *g;\n";
9928 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9930 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9936 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9937 pr " Check_Type (%sv, T_STRING);\n" n;
9938 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9940 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9941 pr " \"%s\", \"%s\");\n" n name
9943 pr " Check_Type (%sv, T_STRING);\n" n;
9944 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
9946 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9947 pr " \"%s\", \"%s\");\n" n name;
9948 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
9950 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9951 | StringList n | DeviceList n ->
9952 pr " char **%s;\n" n;
9953 pr " Check_Type (%sv, T_ARRAY);\n" n;
9955 pr " int i, len;\n";
9956 pr " len = RARRAY_LEN (%sv);\n" n;
9957 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9959 pr " for (i = 0; i < len; ++i) {\n";
9960 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9961 pr " %s[i] = StringValueCStr (v);\n" n;
9963 pr " %s[len] = NULL;\n" n;
9966 pr " int %s = RTEST (%sv);\n" n n
9968 pr " int %s = NUM2INT (%sv);\n" n n
9970 pr " long long %s = NUM2LL (%sv);\n" n n
9975 match fst style with
9976 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9977 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9978 | RConstString _ | RConstOptString _ ->
9979 pr " const char *r;\n"; "NULL"
9980 | RString _ -> pr " char *r;\n"; "NULL"
9981 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9982 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9983 | RStructList (_, typ) ->
9984 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9987 pr " size_t size;\n";
9991 pr " r = guestfs_%s " name;
9992 generate_c_call_args ~handle:"g" style;
9997 | Pathname _ | Device _ | Dev_or_Path _ | String _
9998 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
10000 | StringList n | DeviceList n ->
10001 pr " free (%s);\n" n
10004 pr " if (r == %s)\n" error_code;
10005 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
10008 (match fst style with
10010 pr " return Qnil;\n"
10011 | RInt _ | RBool _ ->
10012 pr " return INT2NUM (r);\n"
10014 pr " return ULL2NUM (r);\n"
10015 | RConstString _ ->
10016 pr " return rb_str_new2 (r);\n";
10017 | RConstOptString _ ->
10019 pr " return rb_str_new2 (r);\n";
10021 pr " return Qnil;\n";
10023 pr " VALUE rv = rb_str_new2 (r);\n";
10025 pr " return rv;\n";
10027 pr " int i, len = 0;\n";
10028 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
10029 pr " VALUE rv = rb_ary_new2 (len);\n";
10030 pr " for (i = 0; r[i] != NULL; ++i) {\n";
10031 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
10032 pr " free (r[i]);\n";
10036 | RStruct (_, typ) ->
10037 let cols = cols_of_struct typ in
10038 generate_ruby_struct_code typ cols
10039 | RStructList (_, typ) ->
10040 let cols = cols_of_struct typ in
10041 generate_ruby_struct_list_code typ cols
10043 pr " VALUE rv = rb_hash_new ();\n";
10045 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
10046 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
10047 pr " free (r[i]);\n";
10048 pr " free (r[i+1]);\n";
10053 pr " VALUE rv = rb_str_new (r, size);\n";
10055 pr " return rv;\n";
10063 /* Initialize the module. */
10064 void Init__guestfs ()
10066 m_guestfs = rb_define_module (\"Guestfs\");
10067 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
10068 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
10070 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
10071 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
10074 (* Define the rest of the methods. *)
10076 fun (name, style, _, _, _, _, _) ->
10077 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
10078 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
10083 (* Ruby code to return a struct. *)
10084 and generate_ruby_struct_code typ cols =
10085 pr " VALUE rv = rb_hash_new ();\n";
10089 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
10091 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
10093 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
10094 | name, (FBytes|FUInt64) ->
10095 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10097 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
10099 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
10101 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
10102 | name, FOptPercent ->
10103 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
10104 | name, FChar -> (* XXX wrong? *)
10105 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
10107 pr " guestfs_free_%s (r);\n" typ;
10110 (* Ruby code to return a struct list. *)
10111 and generate_ruby_struct_list_code typ cols =
10112 pr " VALUE rv = rb_ary_new2 (r->len);\n";
10114 pr " for (i = 0; i < r->len; ++i) {\n";
10115 pr " VALUE hv = rb_hash_new ();\n";
10119 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
10121 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
10123 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
10124 | name, (FBytes|FUInt64) ->
10125 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10127 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
10129 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
10131 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
10132 | name, FOptPercent ->
10133 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
10134 | name, FChar -> (* XXX wrong? *)
10135 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
10137 pr " rb_ary_push (rv, hv);\n";
10139 pr " guestfs_free_%s_list (r);\n" typ;
10142 (* Generate Java bindings GuestFS.java file. *)
10143 and generate_java_java () =
10144 generate_header CStyle LGPLv2plus;
10147 package com.redhat.et.libguestfs;
10149 import java.util.HashMap;
10150 import com.redhat.et.libguestfs.LibGuestFSException;
10151 import com.redhat.et.libguestfs.PV;
10152 import com.redhat.et.libguestfs.VG;
10153 import com.redhat.et.libguestfs.LV;
10154 import com.redhat.et.libguestfs.Stat;
10155 import com.redhat.et.libguestfs.StatVFS;
10156 import com.redhat.et.libguestfs.IntBool;
10157 import com.redhat.et.libguestfs.Dirent;
10160 * The GuestFS object is a libguestfs handle.
10164 public class GuestFS {
10165 // Load the native code.
10167 System.loadLibrary (\"guestfs_jni\");
10171 * The native guestfs_h pointer.
10176 * Create a libguestfs handle.
10178 * @throws LibGuestFSException
10180 public GuestFS () throws LibGuestFSException
10184 private native long _create () throws LibGuestFSException;
10187 * Close a libguestfs handle.
10189 * You can also leave handles to be collected by the garbage
10190 * collector, but this method ensures that the resources used
10191 * by the handle are freed up immediately. If you call any
10192 * other methods after closing the handle, you will get an
10195 * @throws LibGuestFSException
10197 public void close () throws LibGuestFSException
10203 private native void _close (long g) throws LibGuestFSException;
10205 public void finalize () throws LibGuestFSException
10213 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10214 if not (List.mem NotInDocs flags); then (
10215 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10217 if List.mem ProtocolLimitWarning flags then
10218 doc ^ "\n\n" ^ protocol_limit_warning
10221 if List.mem DangerWillRobinson flags then
10222 doc ^ "\n\n" ^ danger_will_robinson
10225 match deprecation_notice flags with
10227 | Some txt -> doc ^ "\n\n" ^ txt in
10228 let doc = pod2text ~width:60 name doc in
10229 let doc = List.map ( (* RHBZ#501883 *)
10232 | nonempty -> nonempty
10234 let doc = String.concat "\n * " doc in
10237 pr " * %s\n" shortdesc;
10240 pr " * @throws LibGuestFSException\n";
10244 generate_java_prototype ~public:true ~semicolon:false name style;
10247 pr " if (g == 0)\n";
10248 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10251 if fst style <> RErr then pr "return ";
10253 generate_java_call_args ~handle:"g" (snd style);
10257 generate_java_prototype ~privat:true ~native:true name style;
10264 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10265 and generate_java_call_args ~handle args =
10267 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10270 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10271 ?(semicolon=true) name style =
10272 if privat then pr "private ";
10273 if public then pr "public ";
10274 if native then pr "native ";
10277 (match fst style with
10278 | RErr -> pr "void ";
10279 | RInt _ -> pr "int ";
10280 | RInt64 _ -> pr "long ";
10281 | RBool _ -> pr "boolean ";
10282 | RConstString _ | RConstOptString _ | RString _
10283 | RBufferOut _ -> pr "String ";
10284 | RStringList _ -> pr "String[] ";
10285 | RStruct (_, typ) ->
10286 let name = java_name_of_struct typ in
10288 | RStructList (_, typ) ->
10289 let name = java_name_of_struct typ in
10291 | RHashtable _ -> pr "HashMap<String,String> ";
10294 if native then pr "_%s " name else pr "%s " name;
10296 let needs_comma = ref false in
10299 needs_comma := true
10305 if !needs_comma then pr ", ";
10306 needs_comma := true;
10310 | Device n | Dev_or_Path n
10318 | StringList n | DeviceList n ->
10329 pr " throws LibGuestFSException";
10330 if semicolon then pr ";"
10332 and generate_java_struct jtyp cols () =
10333 generate_header CStyle LGPLv2plus;
10336 package com.redhat.et.libguestfs;
10339 * Libguestfs %s structure.
10351 | name, FBuffer -> pr " public String %s;\n" name
10352 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10353 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10354 | name, FChar -> pr " public char %s;\n" name
10355 | name, FOptPercent ->
10356 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10357 pr " public float %s;\n" name
10362 and generate_java_c () =
10363 generate_header CStyle LGPLv2plus;
10367 #include <stdlib.h>
10368 #include <string.h>
10370 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10371 #include \"guestfs.h\"
10373 /* Note that this function returns. The exception is not thrown
10374 * until after the wrapper function returns.
10377 throw_exception (JNIEnv *env, const char *msg)
10380 cl = (*env)->FindClass (env,
10381 \"com/redhat/et/libguestfs/LibGuestFSException\");
10382 (*env)->ThrowNew (env, cl, msg);
10385 JNIEXPORT jlong JNICALL
10386 Java_com_redhat_et_libguestfs_GuestFS__1create
10387 (JNIEnv *env, jobject obj)
10391 g = guestfs_create ();
10393 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10396 guestfs_set_error_handler (g, NULL, NULL);
10397 return (jlong) (long) g;
10400 JNIEXPORT void JNICALL
10401 Java_com_redhat_et_libguestfs_GuestFS__1close
10402 (JNIEnv *env, jobject obj, jlong jg)
10404 guestfs_h *g = (guestfs_h *) (long) jg;
10411 fun (name, style, _, _, _, _, _) ->
10413 (match fst style with
10414 | RErr -> pr "void ";
10415 | RInt _ -> pr "jint ";
10416 | RInt64 _ -> pr "jlong ";
10417 | RBool _ -> pr "jboolean ";
10418 | RConstString _ | RConstOptString _ | RString _
10419 | RBufferOut _ -> pr "jstring ";
10420 | RStruct _ | RHashtable _ ->
10422 | RStringList _ | RStructList _ ->
10423 pr "jobjectArray ";
10426 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10427 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10429 pr " (JNIEnv *env, jobject obj, jlong jg";
10433 | Device n | Dev_or_Path n
10438 pr ", jstring j%s" n
10440 pr ", jbyteArray j%s" n
10441 | StringList n | DeviceList n ->
10442 pr ", jobjectArray j%s" n
10444 pr ", jboolean j%s" n
10452 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10453 let error_code, no_ret =
10454 match fst style with
10455 | RErr -> pr " int r;\n"; "-1", ""
10457 | RInt _ -> pr " int r;\n"; "-1", "0"
10458 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10459 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10460 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10462 pr " jstring jr;\n";
10463 pr " char *r;\n"; "NULL", "NULL"
10465 pr " jobjectArray jr;\n";
10466 pr " int r_len;\n";
10467 pr " jclass cl;\n";
10468 pr " jstring jstr;\n";
10469 pr " char **r;\n"; "NULL", "NULL"
10470 | RStruct (_, typ) ->
10471 pr " jobject jr;\n";
10472 pr " jclass cl;\n";
10473 pr " jfieldID fl;\n";
10474 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10475 | RStructList (_, typ) ->
10476 pr " jobjectArray jr;\n";
10477 pr " jclass cl;\n";
10478 pr " jfieldID fl;\n";
10479 pr " jobject jfl;\n";
10480 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10481 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10483 pr " jstring jr;\n";
10485 pr " size_t size;\n";
10490 | Device n | Dev_or_Path n
10495 pr " const char *%s;\n" n
10497 pr " jbyte *%s;\n" n;
10498 pr " size_t %s_size;\n" n
10499 | StringList n | DeviceList n ->
10500 pr " int %s_len;\n" n;
10501 pr " const char **%s;\n" n
10506 pr " int64_t %s;\n" n
10510 (match fst style with
10511 | RStringList _ | RStructList _ -> true
10512 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10513 | RConstOptString _
10514 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10515 List.exists (function
10516 | StringList _ -> true
10517 | DeviceList _ -> true
10518 | _ -> false) (snd style) in
10524 (* Get the parameters. *)
10528 | Device n | Dev_or_Path n
10532 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10534 (* This is completely undocumented, but Java null becomes
10535 * a NULL parameter.
10537 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10539 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10540 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10541 | StringList n | DeviceList n ->
10542 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10543 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10544 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10545 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10547 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10549 pr " %s[%s_len] = NULL;\n" n n;
10553 pr " %s = j%s;\n" n n
10556 (* Make the call. *)
10557 pr " r = guestfs_%s " name;
10558 generate_c_call_args ~handle:"g" style;
10561 (* Release the parameters. *)
10565 | Device n | Dev_or_Path n
10569 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10571 pr " if (j%s)\n" n;
10572 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10574 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10575 | StringList n | DeviceList n ->
10576 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10577 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10579 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10581 pr " free (%s);\n" n
10587 (* Check for errors. *)
10588 pr " if (r == %s) {\n" error_code;
10589 pr " throw_exception (env, guestfs_last_error (g));\n";
10590 pr " return %s;\n" no_ret;
10593 (* Return value. *)
10594 (match fst style with
10596 | RInt _ -> pr " return (jint) r;\n"
10597 | RBool _ -> pr " return (jboolean) r;\n"
10598 | RInt64 _ -> pr " return (jlong) r;\n"
10599 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10600 | RConstOptString _ ->
10601 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10603 pr " jr = (*env)->NewStringUTF (env, r);\n";
10607 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10608 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10609 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10610 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10611 pr " for (i = 0; i < r_len; ++i) {\n";
10612 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10613 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10614 pr " free (r[i]);\n";
10618 | RStruct (_, typ) ->
10619 let jtyp = java_name_of_struct typ in
10620 let cols = cols_of_struct typ in
10621 generate_java_struct_return typ jtyp cols
10622 | RStructList (_, typ) ->
10623 let jtyp = java_name_of_struct typ in
10624 let cols = cols_of_struct typ in
10625 generate_java_struct_list_return typ jtyp cols
10628 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10629 pr " return NULL;\n"
10631 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10640 and generate_java_struct_return typ jtyp cols =
10641 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10642 pr " jr = (*env)->AllocObject (env, cl);\n";
10646 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10647 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10650 pr " char s[33];\n";
10651 pr " memcpy (s, r->%s, 32);\n" name;
10652 pr " s[32] = 0;\n";
10653 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10654 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10658 pr " int len = r->%s_len;\n" name;
10659 pr " char s[len+1];\n";
10660 pr " memcpy (s, r->%s, len);\n" name;
10661 pr " s[len] = 0;\n";
10662 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10663 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10665 | name, (FBytes|FUInt64|FInt64) ->
10666 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10667 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10668 | name, (FUInt32|FInt32) ->
10669 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10670 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10671 | name, FOptPercent ->
10672 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10673 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10675 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10676 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10681 and generate_java_struct_list_return typ jtyp cols =
10682 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10683 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10684 pr " for (i = 0; i < r->len; ++i) {\n";
10685 pr " jfl = (*env)->AllocObject (env, cl);\n";
10689 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10690 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10693 pr " char s[33];\n";
10694 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10695 pr " s[32] = 0;\n";
10696 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10697 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10701 pr " int len = r->val[i].%s_len;\n" name;
10702 pr " char s[len+1];\n";
10703 pr " memcpy (s, r->val[i].%s, len);\n" name;
10704 pr " s[len] = 0;\n";
10705 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10706 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10708 | name, (FBytes|FUInt64|FInt64) ->
10709 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10710 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10711 | name, (FUInt32|FInt32) ->
10712 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10713 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10714 | name, FOptPercent ->
10715 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10716 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10718 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10719 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10721 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10723 pr " guestfs_free_%s_list (r);\n" typ;
10726 and generate_java_makefile_inc () =
10727 generate_header HashStyle GPLv2plus;
10729 pr "java_built_sources = \\\n";
10732 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10734 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10736 and generate_haskell_hs () =
10737 generate_header HaskellStyle LGPLv2plus;
10739 (* XXX We only know how to generate partial FFI for Haskell
10740 * at the moment. Please help out!
10742 let can_generate style =
10746 | RInt64 _, _ -> true
10748 | RConstString _, _
10749 | RConstOptString _, _
10755 | RBufferOut _, _ -> false in
10758 {-# INCLUDE <guestfs.h> #-}
10759 {-# LANGUAGE ForeignFunctionInterface #-}
10764 (* List out the names of the actions we want to export. *)
10766 fun (name, style, _, _, _, _, _) ->
10767 if can_generate style then pr ",\n %s" name
10773 -- Unfortunately some symbols duplicate ones already present
10774 -- in Prelude. We don't know which, so we hard-code a list
10776 import Prelude hiding (truncate)
10780 import Foreign.C.Types
10782 import Control.Exception
10783 import Data.Typeable
10785 data GuestfsS = GuestfsS -- represents the opaque C struct
10786 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10787 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10789 -- XXX define properly later XXX
10793 data IntBool = IntBool
10795 data StatVFS = StatVFS
10796 data Hashtable = Hashtable
10798 foreign import ccall unsafe \"guestfs_create\" c_create
10800 foreign import ccall unsafe \"&guestfs_close\" c_close
10801 :: FunPtr (GuestfsP -> IO ())
10802 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10803 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10805 create :: IO GuestfsH
10808 c_set_error_handler p nullPtr nullPtr
10809 h <- newForeignPtr c_close p
10812 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10813 :: GuestfsP -> IO CString
10815 -- last_error :: GuestfsH -> IO (Maybe String)
10816 -- last_error h = do
10817 -- str <- withForeignPtr h (\\p -> c_last_error p)
10818 -- maybePeek peekCString str
10820 last_error :: GuestfsH -> IO (String)
10822 str <- withForeignPtr h (\\p -> c_last_error p)
10823 if (str == nullPtr)
10824 then return \"no error\"
10825 else peekCString str
10829 (* Generate wrappers for each foreign function. *)
10831 fun (name, style, _, _, _, _, _) ->
10832 if can_generate style then (
10833 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10835 generate_haskell_prototype ~handle:"GuestfsP" style;
10839 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10841 pr "%s %s = do\n" name
10842 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10844 (* Convert pointer arguments using with* functions. *)
10849 | Pathname n | Device n | Dev_or_Path n | String n ->
10850 pr "withCString %s $ \\%s -> " n n
10852 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10853 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10854 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10855 | Bool _ | Int _ | Int64 _ -> ()
10857 (* Convert integer arguments. *)
10861 | Bool n -> sprintf "(fromBool %s)" n
10862 | Int n -> sprintf "(fromIntegral %s)" n
10863 | Int64 n -> sprintf "(fromIntegral %s)" n
10864 | FileIn n | FileOut n
10865 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10866 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
10868 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10869 (String.concat " " ("p" :: args));
10870 (match fst style with
10871 | RErr | RInt _ | RInt64 _ | RBool _ ->
10872 pr " if (r == -1)\n";
10874 pr " err <- last_error h\n";
10876 | RConstString _ | RConstOptString _ | RString _
10877 | RStringList _ | RStruct _
10878 | RStructList _ | RHashtable _ | RBufferOut _ ->
10879 pr " if (r == nullPtr)\n";
10881 pr " err <- last_error h\n";
10884 (match fst style with
10886 pr " else return ()\n"
10888 pr " else return (fromIntegral r)\n"
10890 pr " else return (fromIntegral r)\n"
10892 pr " else return (toBool r)\n"
10894 | RConstOptString _
10901 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10907 and generate_haskell_prototype ~handle ?(hs = false) style =
10908 pr "%s -> " handle;
10909 let string = if hs then "String" else "CString" in
10910 let int = if hs then "Int" else "CInt" in
10911 let bool = if hs then "Bool" else "CInt" in
10912 let int64 = if hs then "Integer" else "Int64" in
10916 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10918 if hs then pr "String"
10919 else pr "CString -> CInt"
10920 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10921 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10922 | Bool _ -> pr "%s" bool
10923 | Int _ -> pr "%s" int
10924 | Int64 _ -> pr "%s" int
10925 | FileIn _ -> pr "%s" string
10926 | FileOut _ -> pr "%s" string
10931 (match fst style with
10932 | RErr -> if not hs then pr "CInt"
10933 | RInt _ -> pr "%s" int
10934 | RInt64 _ -> pr "%s" int64
10935 | RBool _ -> pr "%s" bool
10936 | RConstString _ -> pr "%s" string
10937 | RConstOptString _ -> pr "Maybe %s" string
10938 | RString _ -> pr "%s" string
10939 | RStringList _ -> pr "[%s]" string
10940 | RStruct (_, typ) ->
10941 let name = java_name_of_struct typ in
10943 | RStructList (_, typ) ->
10944 let name = java_name_of_struct typ in
10946 | RHashtable _ -> pr "Hashtable"
10947 | RBufferOut _ -> pr "%s" string
10951 and generate_csharp () =
10952 generate_header CPlusPlusStyle LGPLv2plus;
10954 (* XXX Make this configurable by the C# assembly users. *)
10955 let library = "libguestfs.so.0" in
10958 // These C# bindings are highly experimental at present.
10960 // Firstly they only work on Linux (ie. Mono). In order to get them
10961 // to work on Windows (ie. .Net) you would need to port the library
10962 // itself to Windows first.
10964 // The second issue is that some calls are known to be incorrect and
10965 // can cause Mono to segfault. Particularly: calls which pass or
10966 // return string[], or return any structure value. This is because
10967 // we haven't worked out the correct way to do this from C#.
10969 // The third issue is that when compiling you get a lot of warnings.
10970 // We are not sure whether the warnings are important or not.
10972 // Fourthly we do not routinely build or test these bindings as part
10973 // of the make && make check cycle, which means that regressions might
10976 // Suggestions and patches are welcome.
10980 // gmcs Libguestfs.cs
10981 // mono Libguestfs.exe
10983 // (You'll probably want to add a Test class / static main function
10984 // otherwise this won't do anything useful).
10988 using System.Runtime.InteropServices;
10989 using System.Runtime.Serialization;
10990 using System.Collections;
10994 class Error : System.ApplicationException
10996 public Error (string message) : base (message) {}
10997 protected Error (SerializationInfo info, StreamingContext context) {}
11004 [DllImport (\"%s\")]
11005 static extern IntPtr guestfs_create ();
11009 _handle = guestfs_create ();
11010 if (_handle == IntPtr.Zero)
11011 throw new Error (\"could not create guestfs handle\");
11014 [DllImport (\"%s\")]
11015 static extern void guestfs_close (IntPtr h);
11019 guestfs_close (_handle);
11022 [DllImport (\"%s\")]
11023 static extern string guestfs_last_error (IntPtr h);
11025 " library library library;
11027 (* Generate C# structure bindings. We prefix struct names with
11028 * underscore because C# cannot have conflicting struct names and
11029 * method names (eg. "class stat" and "stat").
11033 pr " [StructLayout (LayoutKind.Sequential)]\n";
11034 pr " public class _%s {\n" typ;
11037 | name, FChar -> pr " char %s;\n" name
11038 | name, FString -> pr " string %s;\n" name
11040 pr " uint %s_len;\n" name;
11041 pr " string %s;\n" name
11043 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
11044 pr " string %s;\n" name
11045 | name, FUInt32 -> pr " uint %s;\n" name
11046 | name, FInt32 -> pr " int %s;\n" name
11047 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
11048 | name, FInt64 -> pr " long %s;\n" name
11049 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
11055 (* Generate C# function bindings. *)
11057 fun (name, style, _, _, _, shortdesc, _) ->
11058 let rec csharp_return_type () =
11059 match fst style with
11061 | RBool n -> "bool"
11063 | RInt64 n -> "long"
11065 | RConstOptString n
11067 | RBufferOut n -> "string"
11068 | RStruct (_,n) -> "_" ^ n
11069 | RHashtable n -> "Hashtable"
11070 | RStringList n -> "string[]"
11071 | RStructList (_,n) -> sprintf "_%s[]" n
11073 and c_return_type () =
11074 match fst style with
11078 | RInt64 _ -> "long"
11080 | RConstOptString _
11082 | RBufferOut _ -> "string"
11083 | RStruct (_,n) -> "_" ^ n
11085 | RStringList _ -> "string[]"
11086 | RStructList (_,n) -> sprintf "_%s[]" n
11088 and c_error_comparison () =
11089 match fst style with
11093 | RInt64 _ -> "== -1"
11095 | RConstOptString _
11101 | RStructList (_,_) -> "== null"
11103 and generate_extern_prototype () =
11104 pr " static extern %s guestfs_%s (IntPtr h"
11105 (c_return_type ()) name;
11108 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11109 | FileIn n | FileOut n
11111 pr ", [In] string %s" n
11112 | StringList n | DeviceList n ->
11113 pr ", [In] string[] %s" n
11123 and generate_public_prototype () =
11124 pr " public %s %s (" (csharp_return_type ()) name;
11125 let comma = ref false in
11127 if !comma then pr ", ";
11132 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
11133 | FileIn n | FileOut n
11135 next (); pr "string %s" n
11136 | StringList n | DeviceList n ->
11137 next (); pr "string[] %s" n
11139 next (); pr "bool %s" n
11141 next (); pr "int %s" n
11143 next (); pr "long %s" n
11147 and generate_call () =
11148 pr "guestfs_%s (_handle" name;
11149 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
11153 pr " [DllImport (\"%s\")]\n" library;
11154 generate_extern_prototype ();
11156 pr " /// <summary>\n";
11157 pr " /// %s\n" shortdesc;
11158 pr " /// </summary>\n";
11159 generate_public_prototype ();
11161 pr " %s r;\n" (c_return_type ());
11164 pr " if (r %s)\n" (c_error_comparison ());
11165 pr " throw new Error (guestfs_last_error (_handle));\n";
11166 (match fst style with
11169 pr " return r != 0 ? true : false;\n"
11171 pr " Hashtable rr = new Hashtable ();\n";
11172 pr " for (int i = 0; i < r.Length; i += 2)\n";
11173 pr " rr.Add (r[i], r[i+1]);\n";
11175 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
11176 | RString _ | RBufferOut _ | RStruct _ | RStringList _
11182 ) all_functions_sorted;
11188 and generate_bindtests () =
11189 generate_header CStyle LGPLv2plus;
11193 #include <stdlib.h>
11194 #include <inttypes.h>
11195 #include <string.h>
11197 #include \"guestfs.h\"
11198 #include \"guestfs-internal.h\"
11199 #include \"guestfs-internal-actions.h\"
11200 #include \"guestfs_protocol.h\"
11202 #define error guestfs_error
11203 #define safe_calloc guestfs_safe_calloc
11204 #define safe_malloc guestfs_safe_malloc
11207 print_strings (char *const *argv)
11212 for (argc = 0; argv[argc] != NULL; ++argc) {
11213 if (argc > 0) printf (\", \");
11214 printf (\"\\\"%%s\\\"\", argv[argc]);
11219 /* The test0 function prints its parameters to stdout. */
11223 match test_functions with
11224 | [] -> assert false
11225 | test0 :: tests -> test0, tests in
11228 let (name, style, _, _, _, _, _) = test0 in
11229 generate_prototype ~extern:false ~semicolon:false ~newline:true
11230 ~handle:"g" ~prefix:"guestfs__" name style;
11235 | Device n | Dev_or_Path n
11238 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
11242 pr " for (i = 0; i < %s_size; ++i)\n" n;
11243 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11244 pr " printf (\"\\n\");\n";
11246 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11247 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11248 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11249 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11250 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11252 pr " /* Java changes stdout line buffering so we need this: */\n";
11253 pr " fflush (stdout);\n";
11259 fun (name, style, _, _, _, _, _) ->
11260 if String.sub name (String.length name - 3) 3 <> "err" then (
11261 pr "/* Test normal return. */\n";
11262 generate_prototype ~extern:false ~semicolon:false ~newline:true
11263 ~handle:"g" ~prefix:"guestfs__" name style;
11265 (match fst style with
11270 pr " sscanf (val, \"%%d\", &r);\n";
11273 pr " int64_t r;\n";
11274 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11277 pr " return STREQ (val, \"true\");\n"
11279 | RConstOptString _ ->
11280 (* Can't return the input string here. Return a static
11281 * string so we ensure we get a segfault if the caller
11282 * tries to free it.
11284 pr " return \"static string\";\n"
11286 pr " return strdup (val);\n"
11288 pr " char **strs;\n";
11290 pr " sscanf (val, \"%%d\", &n);\n";
11291 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11292 pr " for (i = 0; i < n; ++i) {\n";
11293 pr " strs[i] = safe_malloc (g, 16);\n";
11294 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11296 pr " strs[n] = NULL;\n";
11297 pr " return strs;\n"
11298 | RStruct (_, typ) ->
11299 pr " struct guestfs_%s *r;\n" typ;
11300 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11302 | RStructList (_, typ) ->
11303 pr " struct guestfs_%s_list *r;\n" typ;
11304 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11305 pr " sscanf (val, \"%%d\", &r->len);\n";
11306 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11309 pr " char **strs;\n";
11311 pr " sscanf (val, \"%%d\", &n);\n";
11312 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11313 pr " for (i = 0; i < n; ++i) {\n";
11314 pr " strs[i*2] = safe_malloc (g, 16);\n";
11315 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11316 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11317 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11319 pr " strs[n*2] = NULL;\n";
11320 pr " return strs;\n"
11322 pr " return strdup (val);\n"
11327 pr "/* Test error return. */\n";
11328 generate_prototype ~extern:false ~semicolon:false ~newline:true
11329 ~handle:"g" ~prefix:"guestfs__" name style;
11331 pr " error (g, \"error\");\n";
11332 (match fst style with
11333 | RErr | RInt _ | RInt64 _ | RBool _ ->
11335 | RConstString _ | RConstOptString _
11336 | RString _ | RStringList _ | RStruct _
11340 pr " return NULL;\n"
11347 and generate_ocaml_bindtests () =
11348 generate_header OCamlStyle GPLv2plus;
11352 let g = Guestfs.create () in
11356 String.concat " " (
11359 | CallString s -> "\"" ^ s ^ "\""
11360 | CallOptString None -> "None"
11361 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11362 | CallStringList xs ->
11363 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11364 | CallInt i when i >= 0 -> string_of_int i
11365 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11366 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11367 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11368 | CallBool b -> string_of_bool b
11369 | CallBuffer s -> sprintf "%S" s
11374 generate_lang_bindtests (
11375 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11378 pr "print_endline \"EOF\"\n"
11380 and generate_perl_bindtests () =
11381 pr "#!/usr/bin/perl -w\n";
11382 generate_header HashStyle GPLv2plus;
11389 my $g = Sys::Guestfs->new ();
11393 String.concat ", " (
11396 | CallString s -> "\"" ^ s ^ "\""
11397 | CallOptString None -> "undef"
11398 | CallOptString (Some s) -> sprintf "\"%s\"" s
11399 | CallStringList xs ->
11400 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11401 | CallInt i -> string_of_int i
11402 | CallInt64 i -> Int64.to_string i
11403 | CallBool b -> if b then "1" else "0"
11404 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11409 generate_lang_bindtests (
11410 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11413 pr "print \"EOF\\n\"\n"
11415 and generate_python_bindtests () =
11416 generate_header HashStyle GPLv2plus;
11421 g = guestfs.GuestFS ()
11425 String.concat ", " (
11428 | CallString s -> "\"" ^ s ^ "\""
11429 | CallOptString None -> "None"
11430 | CallOptString (Some s) -> sprintf "\"%s\"" s
11431 | CallStringList xs ->
11432 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11433 | CallInt i -> string_of_int i
11434 | CallInt64 i -> Int64.to_string i
11435 | CallBool b -> if b then "1" else "0"
11436 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11441 generate_lang_bindtests (
11442 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11445 pr "print \"EOF\"\n"
11447 and generate_ruby_bindtests () =
11448 generate_header HashStyle GPLv2plus;
11453 g = Guestfs::create()
11457 String.concat ", " (
11460 | CallString s -> "\"" ^ s ^ "\""
11461 | CallOptString None -> "nil"
11462 | CallOptString (Some s) -> sprintf "\"%s\"" s
11463 | CallStringList xs ->
11464 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11465 | CallInt i -> string_of_int i
11466 | CallInt64 i -> Int64.to_string i
11467 | CallBool b -> string_of_bool b
11468 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11473 generate_lang_bindtests (
11474 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11477 pr "print \"EOF\\n\"\n"
11479 and generate_java_bindtests () =
11480 generate_header CStyle GPLv2plus;
11483 import com.redhat.et.libguestfs.*;
11485 public class Bindtests {
11486 public static void main (String[] argv)
11489 GuestFS g = new GuestFS ();
11493 String.concat ", " (
11496 | CallString s -> "\"" ^ s ^ "\""
11497 | CallOptString None -> "null"
11498 | CallOptString (Some s) -> sprintf "\"%s\"" s
11499 | CallStringList xs ->
11501 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11502 | CallInt i -> string_of_int i
11503 | CallInt64 i -> Int64.to_string i
11504 | CallBool b -> string_of_bool b
11506 "new byte[] { " ^ String.concat "," (
11507 map_chars (fun c -> string_of_int (Char.code c)) s
11513 generate_lang_bindtests (
11514 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11518 System.out.println (\"EOF\");
11520 catch (Exception exn) {
11521 System.err.println (exn);
11528 and generate_haskell_bindtests () =
11529 generate_header HaskellStyle GPLv2plus;
11532 module Bindtests where
11533 import qualified Guestfs
11536 g <- Guestfs.create
11540 String.concat " " (
11543 | CallString s -> "\"" ^ s ^ "\""
11544 | CallOptString None -> "Nothing"
11545 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11546 | CallStringList xs ->
11547 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11548 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11549 | CallInt i -> string_of_int i
11550 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11551 | CallInt64 i -> Int64.to_string i
11552 | CallBool true -> "True"
11553 | CallBool false -> "False"
11554 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11559 generate_lang_bindtests (
11560 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11563 pr " putStrLn \"EOF\"\n"
11565 (* Language-independent bindings tests - we do it this way to
11566 * ensure there is parity in testing bindings across all languages.
11568 and generate_lang_bindtests call =
11569 call "test0" [CallString "abc"; CallOptString (Some "def");
11570 CallStringList []; CallBool false;
11571 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11572 CallBuffer "abc\000abc"];
11573 call "test0" [CallString "abc"; CallOptString None;
11574 CallStringList []; CallBool false;
11575 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11576 CallBuffer "abc\000abc"];
11577 call "test0" [CallString ""; CallOptString (Some "def");
11578 CallStringList []; CallBool false;
11579 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11580 CallBuffer "abc\000abc"];
11581 call "test0" [CallString ""; CallOptString (Some "");
11582 CallStringList []; CallBool false;
11583 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11584 CallBuffer "abc\000abc"];
11585 call "test0" [CallString "abc"; CallOptString (Some "def");
11586 CallStringList ["1"]; CallBool false;
11587 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11588 CallBuffer "abc\000abc"];
11589 call "test0" [CallString "abc"; CallOptString (Some "def");
11590 CallStringList ["1"; "2"]; CallBool false;
11591 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11592 CallBuffer "abc\000abc"];
11593 call "test0" [CallString "abc"; CallOptString (Some "def");
11594 CallStringList ["1"]; CallBool true;
11595 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11596 CallBuffer "abc\000abc"];
11597 call "test0" [CallString "abc"; CallOptString (Some "def");
11598 CallStringList ["1"]; CallBool false;
11599 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11600 CallBuffer "abc\000abc"];
11601 call "test0" [CallString "abc"; CallOptString (Some "def");
11602 CallStringList ["1"]; CallBool false;
11603 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11604 CallBuffer "abc\000abc"];
11605 call "test0" [CallString "abc"; CallOptString (Some "def");
11606 CallStringList ["1"]; CallBool false;
11607 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11608 CallBuffer "abc\000abc"];
11609 call "test0" [CallString "abc"; CallOptString (Some "def");
11610 CallStringList ["1"]; CallBool false;
11611 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11612 CallBuffer "abc\000abc"];
11613 call "test0" [CallString "abc"; CallOptString (Some "def");
11614 CallStringList ["1"]; CallBool false;
11615 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11616 CallBuffer "abc\000abc"];
11617 call "test0" [CallString "abc"; CallOptString (Some "def");
11618 CallStringList ["1"]; CallBool false;
11619 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11620 CallBuffer "abc\000abc"]
11622 (* XXX Add here tests of the return and error functions. *)
11624 (* Code to generator bindings for virt-inspector. Currently only
11625 * implemented for OCaml code (for virt-p2v 2.0).
11627 let rng_input = "inspector/virt-inspector.rng"
11629 (* Read the input file and parse it into internal structures. This is
11630 * by no means a complete RELAX NG parser, but is just enough to be
11631 * able to parse the specific input file.
11634 | Element of string * rng list (* <element name=name/> *)
11635 | Attribute of string * rng list (* <attribute name=name/> *)
11636 | Interleave of rng list (* <interleave/> *)
11637 | ZeroOrMore of rng (* <zeroOrMore/> *)
11638 | OneOrMore of rng (* <oneOrMore/> *)
11639 | Optional of rng (* <optional/> *)
11640 | Choice of string list (* <choice><value/>*</choice> *)
11641 | Value of string (* <value>str</value> *)
11642 | Text (* <text/> *)
11644 let rec string_of_rng = function
11645 | Element (name, xs) ->
11646 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11647 | Attribute (name, xs) ->
11648 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11649 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11650 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11651 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11652 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11653 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11654 | Value value -> "Value \"" ^ value ^ "\""
11657 and string_of_rng_list xs =
11658 String.concat ", " (List.map string_of_rng xs)
11660 let rec parse_rng ?defines context = function
11662 | Xml.Element ("element", ["name", name], children) :: rest ->
11663 Element (name, parse_rng ?defines context children)
11664 :: parse_rng ?defines context rest
11665 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11666 Attribute (name, parse_rng ?defines context children)
11667 :: parse_rng ?defines context rest
11668 | Xml.Element ("interleave", [], children) :: rest ->
11669 Interleave (parse_rng ?defines context children)
11670 :: parse_rng ?defines context rest
11671 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11672 let rng = parse_rng ?defines context [child] in
11674 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11676 failwithf "%s: <zeroOrMore> contains more than one child element"
11679 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11680 let rng = parse_rng ?defines context [child] in
11682 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11684 failwithf "%s: <oneOrMore> contains more than one child element"
11687 | Xml.Element ("optional", [], [child]) :: rest ->
11688 let rng = parse_rng ?defines context [child] in
11690 | [child] -> Optional child :: parse_rng ?defines context rest
11692 failwithf "%s: <optional> contains more than one child element"
11695 | Xml.Element ("choice", [], children) :: rest ->
11696 let values = List.map (
11697 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11699 failwithf "%s: can't handle anything except <value> in <choice>"
11703 :: parse_rng ?defines context rest
11704 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11705 Value value :: parse_rng ?defines context rest
11706 | Xml.Element ("text", [], []) :: rest ->
11707 Text :: parse_rng ?defines context rest
11708 | Xml.Element ("ref", ["name", name], []) :: rest ->
11709 (* Look up the reference. Because of limitations in this parser,
11710 * we can't handle arbitrarily nested <ref> yet. You can only
11711 * use <ref> from inside <start>.
11713 (match defines with
11715 failwithf "%s: contains <ref>, but no refs are defined yet" context
11717 let rng = StringMap.find name map in
11718 rng @ parse_rng ?defines context rest
11721 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11724 let xml = Xml.parse_file rng_input in
11726 | Xml.Element ("grammar", _,
11727 Xml.Element ("start", _, gram) :: defines) ->
11728 (* The <define/> elements are referenced in the <start> section,
11729 * so build a map of those first.
11731 let defines = List.fold_left (
11733 function Xml.Element ("define", ["name", name], defn) ->
11734 StringMap.add name defn map
11736 failwithf "%s: expected <define name=name/>" rng_input
11737 ) StringMap.empty defines in
11738 let defines = StringMap.mapi parse_rng defines in
11740 (* Parse the <start> clause, passing the defines. *)
11741 parse_rng ~defines "<start>" gram
11743 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11746 let name_of_field = function
11747 | Element (name, _) | Attribute (name, _)
11748 | ZeroOrMore (Element (name, _))
11749 | OneOrMore (Element (name, _))
11750 | Optional (Element (name, _)) -> name
11751 | Optional (Attribute (name, _)) -> name
11752 | Text -> (* an unnamed field in an element *)
11755 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11757 (* At the moment this function only generates OCaml types. However we
11758 * should parameterize it later so it can generate types/structs in a
11759 * variety of languages.
11761 let generate_types xs =
11762 (* A simple type is one that can be printed out directly, eg.
11763 * "string option". A complex type is one which has a name and has
11764 * to be defined via another toplevel definition, eg. a struct.
11766 * generate_type generates code for either simple or complex types.
11767 * In the simple case, it returns the string ("string option"). In
11768 * the complex case, it returns the name ("mountpoint"). In the
11769 * complex case it has to print out the definition before returning,
11770 * so it should only be called when we are at the beginning of a
11771 * new line (BOL context).
11773 let rec generate_type = function
11774 | Text -> (* string *)
11776 | Choice values -> (* [`val1|`val2|...] *)
11777 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11778 | ZeroOrMore rng -> (* <rng> list *)
11779 let t, is_simple = generate_type rng in
11780 t ^ " list (* 0 or more *)", is_simple
11781 | OneOrMore rng -> (* <rng> list *)
11782 let t, is_simple = generate_type rng in
11783 t ^ " list (* 1 or more *)", is_simple
11784 (* virt-inspector hack: bool *)
11785 | Optional (Attribute (name, [Value "1"])) ->
11787 | Optional rng -> (* <rng> list *)
11788 let t, is_simple = generate_type rng in
11789 t ^ " option", is_simple
11790 (* type name = { fields ... } *)
11791 | Element (name, fields) when is_attrs_interleave fields ->
11792 generate_type_struct name (get_attrs_interleave fields)
11793 | Element (name, [field]) (* type name = field *)
11794 | Attribute (name, [field]) ->
11795 let t, is_simple = generate_type field in
11796 if is_simple then (t, true)
11798 pr "type %s = %s\n" name t;
11801 | Element (name, fields) -> (* type name = { fields ... } *)
11802 generate_type_struct name fields
11804 failwithf "generate_type failed at: %s" (string_of_rng rng)
11806 and is_attrs_interleave = function
11807 | [Interleave _] -> true
11808 | Attribute _ :: fields -> is_attrs_interleave fields
11809 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11812 and get_attrs_interleave = function
11813 | [Interleave fields] -> fields
11814 | ((Attribute _) as field) :: fields
11815 | ((Optional (Attribute _)) as field) :: fields ->
11816 field :: get_attrs_interleave fields
11817 | _ -> assert false
11819 and generate_types xs =
11820 List.iter (fun x -> ignore (generate_type x)) xs
11822 and generate_type_struct name fields =
11823 (* Calculate the types of the fields first. We have to do this
11824 * before printing anything so we are still in BOL context.
11826 let types = List.map fst (List.map generate_type fields) in
11828 (* Special case of a struct containing just a string and another
11829 * field. Turn it into an assoc list.
11832 | ["string"; other] ->
11833 let fname1, fname2 =
11835 | [f1; f2] -> name_of_field f1, name_of_field f2
11836 | _ -> assert false in
11837 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11841 pr "type %s = {\n" name;
11843 fun (field, ftype) ->
11844 let fname = name_of_field field in
11845 pr " %s_%s : %s;\n" name fname ftype
11846 ) (List.combine fields types);
11848 (* Return the name of this type, and
11849 * false because it's not a simple type.
11856 let generate_parsers xs =
11857 (* As for generate_type above, generate_parser makes a parser for
11858 * some type, and returns the name of the parser it has generated.
11859 * Because it (may) need to print something, it should always be
11860 * called in BOL context.
11862 let rec generate_parser = function
11863 | Text -> (* string *)
11864 "string_child_or_empty"
11865 | Choice values -> (* [`val1|`val2|...] *)
11866 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11868 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11869 | ZeroOrMore rng -> (* <rng> list *)
11870 let pa = generate_parser rng in
11871 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11872 | OneOrMore rng -> (* <rng> list *)
11873 let pa = generate_parser rng in
11874 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11875 (* virt-inspector hack: bool *)
11876 | Optional (Attribute (name, [Value "1"])) ->
11877 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11878 | Optional rng -> (* <rng> list *)
11879 let pa = generate_parser rng in
11880 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11881 (* type name = { fields ... } *)
11882 | Element (name, fields) when is_attrs_interleave fields ->
11883 generate_parser_struct name (get_attrs_interleave fields)
11884 | Element (name, [field]) -> (* type name = field *)
11885 let pa = generate_parser field in
11886 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11887 pr "let %s =\n" parser_name;
11889 pr "let parse_%s = %s\n" name parser_name;
11891 | Attribute (name, [field]) ->
11892 let pa = generate_parser field in
11893 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11894 pr "let %s =\n" parser_name;
11896 pr "let parse_%s = %s\n" name parser_name;
11898 | Element (name, fields) -> (* type name = { fields ... } *)
11899 generate_parser_struct name ([], fields)
11901 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11903 and is_attrs_interleave = function
11904 | [Interleave _] -> true
11905 | Attribute _ :: fields -> is_attrs_interleave fields
11906 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11909 and get_attrs_interleave = function
11910 | [Interleave fields] -> [], fields
11911 | ((Attribute _) as field) :: fields
11912 | ((Optional (Attribute _)) as field) :: fields ->
11913 let attrs, interleaves = get_attrs_interleave fields in
11914 (field :: attrs), interleaves
11915 | _ -> assert false
11917 and generate_parsers xs =
11918 List.iter (fun x -> ignore (generate_parser x)) xs
11920 and generate_parser_struct name (attrs, interleaves) =
11921 (* Generate parsers for the fields first. We have to do this
11922 * before printing anything so we are still in BOL context.
11924 let fields = attrs @ interleaves in
11925 let pas = List.map generate_parser fields in
11927 (* Generate an intermediate tuple from all the fields first.
11928 * If the type is just a string + another field, then we will
11929 * return this directly, otherwise it is turned into a record.
11931 * RELAX NG note: This code treats <interleave> and plain lists of
11932 * fields the same. In other words, it doesn't bother enforcing
11933 * any ordering of fields in the XML.
11935 pr "let parse_%s x =\n" name;
11936 pr " let t = (\n ";
11937 let comma = ref false in
11940 if !comma then pr ",\n ";
11943 | Optional (Attribute (fname, [field])), pa ->
11945 | Optional (Element (fname, [field])), pa ->
11946 pr "%s (optional_child %S x)" pa fname
11947 | Attribute (fname, [Text]), _ ->
11948 pr "attribute %S x" fname
11949 | (ZeroOrMore _ | OneOrMore _), pa ->
11954 let fname = name_of_field field in
11955 pr "%s (child %S x)" pa fname
11956 ) (List.combine fields pas);
11960 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11964 pr " (Obj.magic t : %s)\n" name
11968 | (Optional (Attribute (fname, [field])), pa) ->
11969 pr " %s_%s =\n" name fname;
11971 | (Optional (Element (fname, [field])), pa) ->
11972 pr " %s_%s =\n" name fname;
11973 pr " (let x = optional_child %S x in\n" fname;
11976 let fname = name_of_field field in
11977 pr " %s_%s =\n" name fname;
11978 pr " (let x = child %S x in\n" fname;
11980 ) (List.combine fields pas);
11984 sprintf "parse_%s" name
11987 generate_parsers xs
11989 (* Generate ocaml/guestfs_inspector.mli. *)
11990 let generate_ocaml_inspector_mli () =
11991 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11994 (** This is an OCaml language binding to the external [virt-inspector]
11997 For more information, please read the man page [virt-inspector(1)].
12002 generate_types grammar;
12003 pr "(** The nested information returned from the {!inspect} function. *)\n";
12007 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
12008 (** To inspect a libvirt domain called [name], pass a singleton
12009 list: [inspect [name]]. When using libvirt only, you may
12010 optionally pass a libvirt URI using [inspect ~connect:uri ...].
12012 To inspect a disk image or images, pass a list of the filenames
12013 of the disk images: [inspect filenames]
12015 This function inspects the given guest or disk images and
12016 returns a list of operating system(s) found and a large amount
12017 of information about them. In the vast majority of cases,
12018 a virtual machine only contains a single operating system.
12020 If the optional [~xml] parameter is given, then this function
12021 skips running the external virt-inspector program and just
12022 parses the given XML directly (which is expected to be XML
12023 produced from a previous run of virt-inspector). The list of
12024 names and connect URI are ignored in this case.
12026 This function can throw a wide variety of exceptions, for example
12027 if the external virt-inspector program cannot be found, or if
12028 it doesn't generate valid XML.
12032 (* Generate ocaml/guestfs_inspector.ml. *)
12033 let generate_ocaml_inspector_ml () =
12034 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
12039 generate_types grammar;
12043 (* Misc functions which are used by the parser code below. *)
12044 let first_child = function
12045 | Xml.Element (_, _, c::_) -> c
12046 | Xml.Element (name, _, []) ->
12047 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
12048 | Xml.PCData str ->
12049 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
12051 let string_child_or_empty = function
12052 | Xml.Element (_, _, [Xml.PCData s]) -> s
12053 | Xml.Element (_, _, []) -> \"\"
12054 | Xml.Element (x, _, _) ->
12055 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
12057 | Xml.PCData str ->
12058 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
12060 let optional_child name xml =
12061 let children = Xml.children xml in
12063 Some (List.find (function
12064 | Xml.Element (n, _, _) when n = name -> true
12065 | _ -> false) children)
12069 let child name xml =
12070 match optional_child name xml with
12073 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
12075 let attribute name xml =
12076 try Xml.attrib xml name
12077 with Xml.No_attribute _ ->
12078 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
12082 generate_parsers grammar;
12086 (* Run external virt-inspector, then use parser to parse the XML. *)
12087 let inspect ?connect ?xml names =
12091 if names = [] then invalid_arg \"inspect: no names given\";
12092 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
12093 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
12095 let cmd = List.map Filename.quote cmd in
12096 let cmd = String.concat \" \" cmd in
12097 let chan = open_process_in cmd in
12098 let xml = Xml.parse_in chan in
12099 (match close_process_in chan with
12101 | WEXITED _ -> failwith \"external virt-inspector command failed\"
12102 | WSIGNALED i | WSTOPPED i ->
12103 failwith (\"external virt-inspector command died or stopped on sig \" ^
12108 Xml.parse_string doc in
12109 parse_operatingsystems xml
12112 and generate_max_proc_nr () =
12113 pr "%d\n" max_proc_nr
12115 let output_to filename k =
12116 let filename_new = filename ^ ".new" in
12117 chan := open_out filename_new;
12120 chan := Pervasives.stdout;
12122 (* Is the new file different from the current file? *)
12123 if Sys.file_exists filename && files_equal filename filename_new then
12124 unlink filename_new (* same, so skip it *)
12126 (* different, overwrite old one *)
12127 (try chmod filename 0o644 with Unix_error _ -> ());
12128 rename filename_new filename;
12129 chmod filename 0o444;
12130 printf "written %s\n%!" filename;
12133 let perror msg = function
12134 | Unix_error (err, _, _) ->
12135 eprintf "%s: %s\n" msg (error_message err)
12137 eprintf "%s: %s\n" msg (Printexc.to_string exn)
12139 (* Main program. *)
12142 try openfile "HACKING" [O_RDWR] 0
12144 | Unix_error (ENOENT, _, _) ->
12146 You are probably running this from the wrong directory.
12147 Run it from the top source directory using the command
12152 perror "open: HACKING" exn;
12155 (* Acquire a lock so parallel builds won't try to run the generator
12156 * twice at the same time. Subsequent builds will wait for the first
12157 * one to finish. Note the lock is released implicitly when the
12160 (try lockf lock_fd F_LOCK 1
12162 perror "lock: HACKING" exn;
12165 check_functions ();
12167 output_to "src/guestfs_protocol.x" generate_xdr;
12168 output_to "src/guestfs-structs.h" generate_structs_h;
12169 output_to "src/guestfs-actions.h" generate_actions_h;
12170 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
12171 output_to "src/guestfs-actions.c" generate_client_actions;
12172 output_to "src/guestfs-bindtests.c" generate_bindtests;
12173 output_to "src/guestfs-structs.pod" generate_structs_pod;
12174 output_to "src/guestfs-actions.pod" generate_actions_pod;
12175 output_to "src/guestfs-availability.pod" generate_availability_pod;
12176 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
12177 output_to "src/libguestfs.syms" generate_linker_script;
12178 output_to "daemon/actions.h" generate_daemon_actions_h;
12179 output_to "daemon/stubs.c" generate_daemon_actions;
12180 output_to "daemon/names.c" generate_daemon_names;
12181 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
12182 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
12183 output_to "capitests/tests.c" generate_tests;
12184 output_to "fish/cmds.c" generate_fish_cmds;
12185 output_to "fish/completion.c" generate_fish_completion;
12186 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
12187 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
12188 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
12189 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
12190 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
12191 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
12192 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
12193 output_to "perl/Guestfs.xs" generate_perl_xs;
12194 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
12195 output_to "perl/bindtests.pl" generate_perl_bindtests;
12196 output_to "python/guestfs-py.c" generate_python_c;
12197 output_to "python/guestfs.py" generate_python_py;
12198 output_to "python/bindtests.py" generate_python_bindtests;
12199 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12200 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12201 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12205 let cols = cols_of_struct typ in
12206 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12207 output_to filename (generate_java_struct jtyp cols);
12210 output_to "java/Makefile.inc" generate_java_makefile_inc;
12211 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12212 output_to "java/Bindtests.java" generate_java_bindtests;
12213 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12214 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12215 output_to "csharp/Libguestfs.cs" generate_csharp;
12217 (* Always generate this file last, and unconditionally. It's used
12218 * by the Makefile to know when we must re-run the generator.
12220 let chan = open_out "src/stamp-generator" in
12221 fprintf chan "1\n";
12224 printf "generated %d lines of code\n" !lines