3 * Copyright (C) 2009-2010 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 (* This script generates a large amount of code and documentation for
21 * all the daemon actions.
23 * To add a new action there are only two files you need to change,
24 * this one to describe the interface (see the big table of
25 * 'daemon_functions' below), and daemon/<somefile>.c to write the
28 * After editing this file, run it (./src/generator.ml) to regenerate
29 * all the output files. 'make' will rerun this automatically when
30 * necessary. Note that if you are using a separate build directory
31 * you must run generator.ml from the _source_ directory.
33 * IMPORTANT: This script should NOT print any warnings. If it prints
34 * warnings, you should treat them as errors.
37 * (1) In emacs, install tuareg-mode to display and format OCaml code
38 * correctly. 'vim' comes with a good OCaml editing mode by default.
39 * (2) Read the resources at http://ocaml-tutorial.org/
44 #directory "+xml-light";;
45 #directory "+../pkg-lib/xml-light";; (* for GODI users *)
46 #load "xml-light.cma";;
51 type style = ret * args
53 (* "RErr" as a return value means an int used as a simple error
54 * indication, ie. 0 or -1.
58 (* "RInt" as a return value means an int which is -1 for error
59 * or any value >= 0 on success. Only use this for smallish
60 * positive ints (0 <= i < 2^30).
64 (* "RInt64" is the same as RInt, but is guaranteed to be able
65 * to return a full 64 bit value, _except_ that -1 means error
66 * (so -1 cannot be a valid, non-error return value).
70 (* "RBool" is a bool return value which can be true/false or
75 (* "RConstString" is a string that refers to a constant value.
76 * The return value must NOT be NULL (since NULL indicates
79 * Try to avoid using this. In particular you cannot use this
80 * for values returned from the daemon, because there is no
81 * thread-safe way to return them in the C API.
83 | RConstString of string
85 (* "RConstOptString" is an even more broken version of
86 * "RConstString". The returned string may be NULL and there
87 * is no way to return an error indication. Avoid using this!
89 | RConstOptString of string
91 (* "RString" is a returned string. It must NOT be NULL, since
92 * a NULL return indicates an error. The caller frees this.
96 (* "RStringList" is a list of strings. No string in the list
97 * can be NULL. The caller frees the strings and the array.
99 | RStringList of string
101 (* "RStruct" is a function which returns a single named structure
102 * or an error indication (in C, a struct, and in other languages
103 * with varying representations, but usually very efficient). See
104 * after the function list below for the structures.
106 | RStruct of string * string (* name of retval, name of struct *)
108 (* "RStructList" is a function which returns either a list/array
109 * of structures (could be zero-length), or an error indication.
111 | RStructList of string * string (* name of retval, name of struct *)
113 (* Key-value pairs of untyped strings. Turns into a hashtable or
114 * dictionary in languages which support it. DON'T use this as a
115 * general "bucket" for results. Prefer a stronger typed return
116 * value if one is available, or write a custom struct. Don't use
117 * this if the list could potentially be very long, since it is
118 * inefficient. Keys should be unique. NULLs are not permitted.
120 | RHashtable of string
122 (* "RBufferOut" is handled almost exactly like RString, but
123 * it allows the string to contain arbitrary 8 bit data including
124 * ASCII NUL. In the C API this causes an implicit extra parameter
125 * to be added of type <size_t *size_r>. The extra parameter
126 * returns the actual size of the return buffer in bytes.
128 * Other programming languages support strings with arbitrary 8 bit
131 * At the RPC layer we have to use the opaque<> type instead of
132 * string<>. Returned data is still limited to the max message
135 | RBufferOut of string
137 and args = argt list (* Function parameters, guestfs handle is implicit. *)
139 (* Note in future we should allow a "variable args" parameter as
140 * the final parameter, to allow commands like
141 * chmod mode file [file(s)...]
142 * This is not implemented yet, but many commands (such as chmod)
143 * are currently defined with the argument order keeping this future
144 * possibility in mind.
147 | String of string (* const char *name, cannot be NULL *)
148 | Device of string (* /dev device name, cannot be NULL *)
149 | Pathname of string (* file name, cannot be NULL *)
150 | Dev_or_Path of string (* /dev device name or Pathname, cannot be NULL *)
151 | OptString of string (* const char *name, may be NULL *)
152 | StringList of string(* list of strings (each string cannot be NULL) *)
153 | DeviceList of string(* list of Device names (each cannot be NULL) *)
154 | Bool of string (* boolean *)
155 | Int of string (* int (smallish ints, signed, <= 31 bits) *)
156 | Int64 of string (* any 64 bit int *)
157 (* These are treated as filenames (simple string parameters) in
158 * the C API and bindings. But in the RPC protocol, we transfer
159 * the actual file content up to or down from the daemon.
160 * FileIn: local machine -> daemon (in request)
161 * FileOut: daemon -> local machine (in reply)
162 * In guestfish (only), the special name "-" means read from
163 * stdin or write to stdout.
167 (* Opaque buffer which can contain arbitrary 8 bit data.
168 * In the C API, this is expressed as <const char *, size_t> pair.
169 * Most other languages have a string type which can contain
170 * ASCII NUL. We use whatever type is appropriate for each
172 * Buffers are limited by the total message size. To transfer
173 * large blocks of data, use FileIn/FileOut parameters instead.
174 * To return an arbitrary buffer, use RBufferOut.
179 | ProtocolLimitWarning (* display warning about protocol size limits *)
180 | DangerWillRobinson (* flags particularly dangerous commands *)
181 | FishAlias of string (* provide an alias for this cmd in guestfish *)
182 | FishOutput of fish_output_t (* how to display output in guestfish *)
183 | NotInFish (* do not export via guestfish *)
184 | NotInDocs (* do not add this function to documentation *)
185 | DeprecatedBy of string (* function is deprecated, use .. instead *)
186 | Optional of string (* function is part of an optional group *)
189 | FishOutputOctal (* for int return, print in octal *)
190 | FishOutputHexadecimal (* for int return, print in hex *)
192 (* You can supply zero or as many tests as you want per API call.
194 * Note that the test environment has 3 block devices, of size 500MB,
195 * 50MB and 10MB (respectively /dev/sda, /dev/sdb, /dev/sdc), and
196 * a fourth ISO block device with some known files on it (/dev/sdd).
198 * Note for partitioning purposes, the 500MB device has 1015 cylinders.
199 * Number of cylinders was 63 for IDE emulated disks with precisely
200 * the same size. How exactly this is calculated is a mystery.
202 * The ISO block device (/dev/sdd) comes from images/test.iso.
204 * To be able to run the tests in a reasonable amount of time,
205 * the virtual machine and block devices are reused between tests.
206 * So don't try testing kill_subprocess :-x
208 * Between each test we blockdev-setrw, umount-all, lvm-remove-all.
210 * Don't assume anything about the previous contents of the block
211 * devices. Use 'Init*' to create some initial scenarios.
213 * You can add a prerequisite clause to any individual test. This
214 * is a run-time check, which, if it fails, causes the test to be
215 * skipped. Useful if testing a command which might not work on
216 * all variations of libguestfs builds. A test that has prerequisite
217 * of 'Always' is run unconditionally.
219 * In addition, packagers can skip individual tests by setting the
220 * environment variables: eg:
221 * SKIP_TEST_<CMD>_<NUM>=1 SKIP_TEST_COMMAND_3=1 (skips test #3 of command)
222 * SKIP_TEST_<CMD>=1 SKIP_TEST_ZEROFREE=1 (skips all zerofree tests)
224 type tests = (test_init * test_prereq * test) list
226 (* Run the command sequence and just expect nothing to fail. *)
229 (* Run the command sequence and expect the output of the final
230 * command to be the string.
232 | TestOutput of seq * string
234 (* Run the command sequence and expect the output of the final
235 * command to be the list of strings.
237 | TestOutputList of seq * string list
239 (* Run the command sequence and expect the output of the final
240 * command to be the list of block devices (could be either
241 * "/dev/sd.." or "/dev/hd.." form - we don't check the 5th
242 * character of each string).
244 | TestOutputListOfDevices of seq * string list
246 (* Run the command sequence and expect the output of the final
247 * command to be the integer.
249 | TestOutputInt of seq * int
251 (* Run the command sequence and expect the output of the final
252 * command to be <op> <int>, eg. ">=", "1".
254 | TestOutputIntOp of seq * string * int
256 (* Run the command sequence and expect the output of the final
257 * command to be a true value (!= 0 or != NULL).
259 | TestOutputTrue of seq
261 (* Run the command sequence and expect the output of the final
262 * command to be a false value (== 0 or == NULL, but not an error).
264 | TestOutputFalse of seq
266 (* Run the command sequence and expect the output of the final
267 * command to be a list of the given length (but don't care about
270 | TestOutputLength of seq * int
272 (* Run the command sequence and expect the output of the final
273 * command to be a buffer (RBufferOut), ie. string + size.
275 | TestOutputBuffer of seq * string
277 (* Run the command sequence and expect the output of the final
278 * command to be a structure.
280 | TestOutputStruct of seq * test_field_compare list
282 (* Run the command sequence and expect the final command (only)
285 | TestLastFail of seq
287 and test_field_compare =
288 | CompareWithInt of string * int
289 | CompareWithIntOp of string * string * int
290 | CompareWithString of string * string
291 | CompareFieldsIntEq of string * string
292 | CompareFieldsStrEq of string * string
294 (* Test prerequisites. *)
296 (* Test always runs. *)
299 (* Test is currently disabled - eg. it fails, or it tests some
300 * unimplemented feature.
304 (* 'string' is some C code (a function body) that should return
305 * true or false. The test will run if the code returns true.
309 (* As for 'If' but the test runs _unless_ the code returns true. *)
312 (* Some initial scenarios for testing. *)
314 (* Do nothing, block devices could contain random stuff including
315 * LVM PVs, and some filesystems might be mounted. This is usually
320 (* Block devices are empty and no filesystems are mounted. *)
323 (* /dev/sda contains a single partition /dev/sda1, with random
324 * content. /dev/sdb and /dev/sdc may have random content.
329 (* /dev/sda contains a single partition /dev/sda1, which is formatted
330 * as ext2, empty [except for lost+found] and mounted on /.
331 * /dev/sdb and /dev/sdc may have random content.
337 * /dev/sda1 (is a PV):
338 * /dev/VG/LV (size 8MB):
339 * formatted as ext2, empty [except for lost+found], mounted on /
340 * /dev/sdb and /dev/sdc may have random content.
344 (* /dev/sdd (the ISO, see images/ directory in source)
349 (* Sequence of commands for testing. *)
351 and cmd = string list
353 (* Note about long descriptions: When referring to another
354 * action, use the format C<guestfs_other> (ie. the full name of
355 * the C function). This will be replaced as appropriate in other
358 * Apart from that, long descriptions are just perldoc paragraphs.
361 (* Generate a random UUID (used in tests). *)
363 let chan = open_process_in "uuidgen" in
364 let uuid = input_line chan in
365 (match close_process_in chan with
368 failwith "uuidgen: process exited with non-zero status"
369 | WSIGNALED _ | WSTOPPED _ ->
370 failwith "uuidgen: process signalled or stopped by signal"
374 (* These test functions are used in the language binding tests. *)
376 let test_all_args = [
379 StringList "strlist";
388 let test_all_rets = [
389 (* except for RErr, which is tested thoroughly elsewhere *)
390 "test0rint", RInt "valout";
391 "test0rint64", RInt64 "valout";
392 "test0rbool", RBool "valout";
393 "test0rconststring", RConstString "valout";
394 "test0rconstoptstring", RConstOptString "valout";
395 "test0rstring", RString "valout";
396 "test0rstringlist", RStringList "valout";
397 "test0rstruct", RStruct ("valout", "lvm_pv");
398 "test0rstructlist", RStructList ("valout", "lvm_pv");
399 "test0rhashtable", RHashtable "valout";
402 let test_functions = [
403 ("test0", (RErr, test_all_args), -1, [NotInFish; NotInDocs],
405 "internal test function - do not use",
407 This is an internal test function which is used to test whether
408 the automatically generated bindings can handle every possible
409 parameter type correctly.
411 It echos the contents of each parameter to stdout.
413 You probably don't want to call this function.");
417 [(name, (ret, [String "val"]), -1, [NotInFish; NotInDocs],
419 "internal test function - do not use",
421 This is an internal test function which is used to test whether
422 the automatically generated bindings can handle every possible
423 return type correctly.
425 It converts string C<val> to the return type.
427 You probably don't want to call this function.");
428 (name ^ "err", (ret, []), -1, [NotInFish; NotInDocs],
430 "internal test function - do not use",
432 This is an internal test function which is used to test whether
433 the automatically generated bindings can handle every possible
434 return type correctly.
436 This function always returns an error.
438 You probably don't want to call this function.")]
442 (* non_daemon_functions are any functions which don't get processed
443 * in the daemon, eg. functions for setting and getting local
444 * configuration values.
447 let non_daemon_functions = test_functions @ [
448 ("launch", (RErr, []), -1, [FishAlias "run"],
450 "launch the qemu subprocess",
452 Internally libguestfs is implemented by running a virtual machine
455 You should call this after configuring the handle
456 (eg. adding drives) but before performing any actions.");
458 ("wait_ready", (RErr, []), -1, [NotInFish],
460 "wait until the qemu subprocess launches (no op)",
462 This function is a no op.
464 In versions of the API E<lt> 1.0.71 you had to call this function
465 just after calling C<guestfs_launch> to wait for the launch
466 to complete. However this is no longer necessary because
467 C<guestfs_launch> now does the waiting.
469 If you see any calls to this function in code then you can just
470 remove them, unless you want to retain compatibility with older
471 versions of the API.");
473 ("kill_subprocess", (RErr, []), -1, [],
475 "kill the qemu subprocess",
477 This kills the qemu subprocess. You should never need to call this.");
479 ("add_drive", (RErr, [String "filename"]), -1, [FishAlias "add"],
481 "add an image to examine or modify",
483 This function adds a virtual machine disk image C<filename> to the
484 guest. The first time you call this function, the disk appears as IDE
485 disk 0 (C</dev/sda>) in the guest, the second time as C</dev/sdb>, and
488 You don't necessarily need to be root when using libguestfs. However
489 you obviously do need sufficient permissions to access the filename
490 for whatever operations you want to perform (ie. read access if you
491 just want to read the image or write access if you want to modify the
494 This is equivalent to the qemu parameter
495 C<-drive file=filename,cache=off,if=...>.
497 C<cache=off> is omitted in cases where it is not supported by
498 the underlying filesystem.
500 C<if=...> is set at compile time by the configuration option
501 C<./configure --with-drive-if=...>. In the rare case where you
502 might need to change this at run time, use C<guestfs_add_drive_with_if>
503 or C<guestfs_add_drive_ro_with_if>.
505 Note that this call checks for the existence of C<filename>. This
506 stops you from specifying other types of drive which are supported
507 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
508 the general C<guestfs_config> call instead.");
510 ("add_cdrom", (RErr, [String "filename"]), -1, [FishAlias "cdrom"],
512 "add a CD-ROM disk image to examine",
514 This function adds a virtual CD-ROM disk image to the guest.
516 This is equivalent to the qemu parameter C<-cdrom filename>.
524 This call checks for the existence of C<filename>. This
525 stops you from specifying other types of drive which are supported
526 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
527 the general C<guestfs_config> call instead.
531 If you just want to add an ISO file (often you use this as an
532 efficient way to transfer large files into the guest), then you
533 should probably use C<guestfs_add_drive_ro> instead.
537 ("add_drive_ro", (RErr, [String "filename"]), -1, [FishAlias "add-ro"],
539 "add a drive in snapshot mode (read-only)",
541 This adds a drive in snapshot mode, making it effectively
544 Note that writes to the device are allowed, and will be seen for
545 the duration of the guestfs handle, but they are written
546 to a temporary file which is discarded as soon as the guestfs
547 handle is closed. We don't currently have any method to enable
548 changes to be committed, although qemu can support this.
550 This is equivalent to the qemu parameter
551 C<-drive file=filename,snapshot=on,readonly=on,if=...>.
553 C<if=...> is set at compile time by the configuration option
554 C<./configure --with-drive-if=...>. In the rare case where you
555 might need to change this at run time, use C<guestfs_add_drive_with_if>
556 or C<guestfs_add_drive_ro_with_if>.
558 C<readonly=on> is only added where qemu supports this option.
560 Note that this call checks for the existence of C<filename>. This
561 stops you from specifying other types of drive which are supported
562 by qemu such as C<nbd:> and C<http:> URLs. To specify those, use
563 the general C<guestfs_config> call instead.");
565 ("config", (RErr, [String "qemuparam"; OptString "qemuvalue"]), -1, [],
567 "add qemu parameters",
569 This can be used to add arbitrary qemu command line parameters
570 of the form C<-param value>. Actually it's not quite arbitrary - we
571 prevent you from setting some parameters which would interfere with
572 parameters that we use.
574 The first character of C<param> string must be a C<-> (dash).
576 C<value> can be NULL.");
578 ("set_qemu", (RErr, [OptString "qemu"]), -1, [FishAlias "qemu"],
580 "set the qemu binary",
582 Set the qemu binary that we will use.
584 The default is chosen when the library was compiled by the
587 You can also override this by setting the C<LIBGUESTFS_QEMU>
588 environment variable.
590 Setting C<qemu> to C<NULL> restores the default qemu binary.
592 Note that you should call this function as early as possible
593 after creating the handle. This is because some pre-launch
594 operations depend on testing qemu features (by running C<qemu -help>).
595 If the qemu binary changes, we don't retest features, and
596 so you might see inconsistent results. Using the environment
597 variable C<LIBGUESTFS_QEMU> is safest of all since that picks
598 the qemu binary at the same time as the handle is created.");
600 ("get_qemu", (RConstString "qemu", []), -1, [],
601 [InitNone, Always, TestRun (
603 "get the qemu binary",
605 Return the current qemu binary.
607 This is always non-NULL. If it wasn't set already, then this will
608 return the default qemu binary name.");
610 ("set_path", (RErr, [OptString "searchpath"]), -1, [FishAlias "path"],
612 "set the search path",
614 Set the path that libguestfs searches for kernel and initrd.img.
616 The default is C<$libdir/guestfs> unless overridden by setting
617 C<LIBGUESTFS_PATH> environment variable.
619 Setting C<path> to C<NULL> restores the default path.");
621 ("get_path", (RConstString "path", []), -1, [],
622 [InitNone, Always, TestRun (
624 "get the search path",
626 Return the current search path.
628 This is always non-NULL. If it wasn't set already, then this will
629 return the default path.");
631 ("set_append", (RErr, [OptString "append"]), -1, [FishAlias "append"],
633 "add options to kernel command line",
635 This function is used to add additional options to the
636 guest kernel command line.
638 The default is C<NULL> unless overridden by setting
639 C<LIBGUESTFS_APPEND> environment variable.
641 Setting C<append> to C<NULL> means I<no> additional options
642 are passed (libguestfs always adds a few of its own).");
644 ("get_append", (RConstOptString "append", []), -1, [],
645 (* This cannot be tested with the current framework. The
646 * function can return NULL in normal operations, which the
647 * test framework interprets as an error.
650 "get the additional kernel options",
652 Return the additional kernel options which are added to the
653 guest kernel command line.
655 If C<NULL> then no options are added.");
657 ("set_autosync", (RErr, [Bool "autosync"]), -1, [FishAlias "autosync"],
661 If C<autosync> is true, this enables autosync. Libguestfs will make a
662 best effort attempt to run C<guestfs_umount_all> followed by
663 C<guestfs_sync> when the handle is closed
664 (also if the program exits without closing handles).
666 This is disabled by default (except in guestfish where it is
667 enabled by default).");
669 ("get_autosync", (RBool "autosync", []), -1, [],
670 [InitNone, Always, TestRun (
671 [["get_autosync"]])],
674 Get the autosync flag.");
676 ("set_verbose", (RErr, [Bool "verbose"]), -1, [FishAlias "verbose"],
680 If C<verbose> is true, this turns on verbose messages (to C<stderr>).
682 Verbose messages are disabled unless the environment variable
683 C<LIBGUESTFS_DEBUG> is defined and set to C<1>.");
685 ("get_verbose", (RBool "verbose", []), -1, [],
689 This returns the verbose messages flag.");
691 ("is_ready", (RBool "ready", []), -1, [],
692 [InitNone, Always, TestOutputTrue (
694 "is ready to accept commands",
696 This returns true iff this handle is ready to accept commands
697 (in the C<READY> state).
699 For more information on states, see L<guestfs(3)>.");
701 ("is_config", (RBool "config", []), -1, [],
702 [InitNone, Always, TestOutputFalse (
704 "is in configuration state",
706 This returns true iff this handle is being configured
707 (in the C<CONFIG> state).
709 For more information on states, see L<guestfs(3)>.");
711 ("is_launching", (RBool "launching", []), -1, [],
712 [InitNone, Always, TestOutputFalse (
713 [["is_launching"]])],
714 "is launching subprocess",
716 This returns true iff this handle is launching the subprocess
717 (in the C<LAUNCHING> state).
719 For more information on states, see L<guestfs(3)>.");
721 ("is_busy", (RBool "busy", []), -1, [],
722 [InitNone, Always, TestOutputFalse (
724 "is busy processing a command",
726 This returns true iff this handle is busy processing a command
727 (in the C<BUSY> state).
729 For more information on states, see L<guestfs(3)>.");
731 ("get_state", (RInt "state", []), -1, [],
733 "get the current state",
735 This returns the current state as an opaque integer. This is
736 only useful for printing debug and internal error messages.
738 For more information on states, see L<guestfs(3)>.");
740 ("set_memsize", (RErr, [Int "memsize"]), -1, [FishAlias "memsize"],
741 [InitNone, Always, TestOutputInt (
742 [["set_memsize"; "500"];
743 ["get_memsize"]], 500)],
744 "set memory allocated to the qemu subprocess",
746 This sets the memory size in megabytes allocated to the
747 qemu subprocess. This only has any effect if called before
750 You can also change this by setting the environment
751 variable C<LIBGUESTFS_MEMSIZE> before the handle is
754 For more information on the architecture of libguestfs,
755 see L<guestfs(3)>.");
757 ("get_memsize", (RInt "memsize", []), -1, [],
758 [InitNone, Always, TestOutputIntOp (
759 [["get_memsize"]], ">=", 256)],
760 "get memory allocated to the qemu subprocess",
762 This gets the memory size in megabytes allocated to the
765 If C<guestfs_set_memsize> was not called
766 on this handle, and if C<LIBGUESTFS_MEMSIZE> was not set,
767 then this returns the compiled-in default value for memsize.
769 For more information on the architecture of libguestfs,
770 see L<guestfs(3)>.");
772 ("get_pid", (RInt "pid", []), -1, [FishAlias "pid"],
773 [InitNone, Always, TestOutputIntOp (
774 [["get_pid"]], ">=", 1)],
775 "get PID of qemu subprocess",
777 Return the process ID of the qemu subprocess. If there is no
778 qemu subprocess, then this will return an error.
780 This is an internal call used for debugging and testing.");
782 ("version", (RStruct ("version", "version"), []), -1, [],
783 [InitNone, Always, TestOutputStruct (
784 [["version"]], [CompareWithInt ("major", 1)])],
785 "get the library version number",
787 Return the libguestfs version number that the program is linked
790 Note that because of dynamic linking this is not necessarily
791 the version of libguestfs that you compiled against. You can
792 compile the program, and then at runtime dynamically link
793 against a completely different C<libguestfs.so> library.
795 This call was added in version C<1.0.58>. In previous
796 versions of libguestfs there was no way to get the version
797 number. From C code you can use ELF weak linking tricks to find out if
798 this symbol exists (if it doesn't, then it's an earlier version).
800 The call returns a structure with four elements. The first
801 three (C<major>, C<minor> and C<release>) are numbers and
802 correspond to the usual version triplet. The fourth element
803 (C<extra>) is a string and is normally empty, but may be
804 used for distro-specific information.
806 To construct the original version string:
807 C<$major.$minor.$release$extra>
809 I<Note:> Don't use this call to test for availability
810 of features. Distro backports makes this unreliable. Use
811 C<guestfs_available> instead.");
813 ("set_selinux", (RErr, [Bool "selinux"]), -1, [FishAlias "selinux"],
814 [InitNone, Always, TestOutputTrue (
815 [["set_selinux"; "true"];
817 "set SELinux enabled or disabled at appliance boot",
819 This sets the selinux flag that is passed to the appliance
820 at boot time. The default is C<selinux=0> (disabled).
822 Note that if SELinux is enabled, it is always in
823 Permissive mode (C<enforcing=0>).
825 For more information on the architecture of libguestfs,
826 see L<guestfs(3)>.");
828 ("get_selinux", (RBool "selinux", []), -1, [],
830 "get SELinux enabled flag",
832 This returns the current setting of the selinux flag which
833 is passed to the appliance at boot time. See C<guestfs_set_selinux>.
835 For more information on the architecture of libguestfs,
836 see L<guestfs(3)>.");
838 ("set_trace", (RErr, [Bool "trace"]), -1, [FishAlias "trace"],
839 [InitNone, Always, TestOutputFalse (
840 [["set_trace"; "false"];
842 "enable or disable command traces",
844 If the command trace flag is set to 1, then commands are
845 printed on stdout before they are executed in a format
846 which is very similar to the one used by guestfish. In
847 other words, you can run a program with this enabled, and
848 you will get out a script which you can feed to guestfish
849 to perform the same set of actions.
851 If you want to trace C API calls into libguestfs (and
852 other libraries) then possibly a better way is to use
853 the external ltrace(1) command.
855 Command traces are disabled unless the environment variable
856 C<LIBGUESTFS_TRACE> is defined and set to C<1>.");
858 ("get_trace", (RBool "trace", []), -1, [],
860 "get command trace enabled flag",
862 Return the command trace flag.");
864 ("set_direct", (RErr, [Bool "direct"]), -1, [FishAlias "direct"],
865 [InitNone, Always, TestOutputFalse (
866 [["set_direct"; "false"];
868 "enable or disable direct appliance mode",
870 If the direct appliance mode flag is enabled, then stdin and
871 stdout are passed directly through to the appliance once it
874 One consequence of this is that log messages aren't caught
875 by the library and handled by C<guestfs_set_log_message_callback>,
876 but go straight to stdout.
878 You probably don't want to use this unless you know what you
881 The default is disabled.");
883 ("get_direct", (RBool "direct", []), -1, [],
885 "get direct appliance mode flag",
887 Return the direct appliance mode flag.");
889 ("set_recovery_proc", (RErr, [Bool "recoveryproc"]), -1, [FishAlias "recovery-proc"],
890 [InitNone, Always, TestOutputTrue (
891 [["set_recovery_proc"; "true"];
892 ["get_recovery_proc"]])],
893 "enable or disable the recovery process",
895 If this is called with the parameter C<false> then
896 C<guestfs_launch> does not create a recovery process. The
897 purpose of the recovery process is to stop runaway qemu
898 processes in the case where the main program aborts abruptly.
900 This only has any effect if called before C<guestfs_launch>,
901 and the default is true.
903 About the only time when you would want to disable this is
904 if the main process will fork itself into the background
905 (\"daemonize\" itself). In this case the recovery process
906 thinks that the main program has disappeared and so kills
907 qemu, which is not very helpful.");
909 ("get_recovery_proc", (RBool "recoveryproc", []), -1, [],
911 "get recovery process enabled flag",
913 Return the recovery process enabled flag.");
915 ("add_drive_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
917 "add a drive specifying the QEMU block emulation to use",
919 This is the same as C<guestfs_add_drive> but it allows you
920 to specify the QEMU interface emulation to use at run time.");
922 ("add_drive_ro_with_if", (RErr, [String "filename"; String "iface"]), -1, [],
924 "add a drive read-only specifying the QEMU block emulation to use",
926 This is the same as C<guestfs_add_drive_ro> but it allows you
927 to specify the QEMU interface emulation to use at run time.");
931 (* daemon_functions are any functions which cause some action
932 * to take place in the daemon.
935 let daemon_functions = [
936 ("mount", (RErr, [Device "device"; String "mountpoint"]), 1, [],
937 [InitEmpty, Always, TestOutput (
938 [["part_disk"; "/dev/sda"; "mbr"];
939 ["mkfs"; "ext2"; "/dev/sda1"];
940 ["mount"; "/dev/sda1"; "/"];
941 ["write"; "/new"; "new file contents"];
942 ["cat"; "/new"]], "new file contents")],
943 "mount a guest disk at a position in the filesystem",
945 Mount a guest disk at a position in the filesystem. Block devices
946 are named C</dev/sda>, C</dev/sdb> and so on, as they were added to
947 the guest. If those block devices contain partitions, they will have
948 the usual names (eg. C</dev/sda1>). Also LVM C</dev/VG/LV>-style
951 The rules are the same as for L<mount(2)>: A filesystem must
952 first be mounted on C</> before others can be mounted. Other
953 filesystems can only be mounted on directories which already
956 The mounted filesystem is writable, if we have sufficient permissions
957 on the underlying device.
960 When you use this call, the filesystem options C<sync> and C<noatime>
961 are set implicitly. This was originally done because we thought it
962 would improve reliability, but it turns out that I<-o sync> has a
963 very large negative performance impact and negligible effect on
964 reliability. Therefore we recommend that you avoid using
965 C<guestfs_mount> in any code that needs performance, and instead
966 use C<guestfs_mount_options> (use an empty string for the first
967 parameter if you don't want any options).");
969 ("sync", (RErr, []), 2, [],
970 [ InitEmpty, Always, TestRun [["sync"]]],
971 "sync disks, writes are flushed through to the disk image",
973 This syncs the disk, so that any writes are flushed through to the
974 underlying disk image.
976 You should always call this if you have modified a disk image, before
977 closing the handle.");
979 ("touch", (RErr, [Pathname "path"]), 3, [],
980 [InitBasicFS, Always, TestOutputTrue (
982 ["exists"; "/new"]])],
983 "update file timestamps or create a new file",
985 Touch acts like the L<touch(1)> command. It can be used to
986 update the timestamps on a file, or, if the file does not exist,
987 to create a new zero-length file.");
989 ("cat", (RString "content", [Pathname "path"]), 4, [ProtocolLimitWarning],
990 [InitISOFS, Always, TestOutput (
991 [["cat"; "/known-2"]], "abcdef\n")],
992 "list the contents of a file",
994 Return the contents of the file named C<path>.
996 Note that this function cannot correctly handle binary files
997 (specifically, files containing C<\\0> character which is treated
998 as end of string). For those you need to use the C<guestfs_read_file>
999 or C<guestfs_download> functions which have a more complex interface.");
1001 ("ll", (RString "listing", [Pathname "directory"]), 5, [],
1002 [], (* XXX Tricky to test because it depends on the exact format
1003 * of the 'ls -l' command, which changes between F10 and F11.
1005 "list the files in a directory (long format)",
1007 List the files in C<directory> (relative to the root directory,
1008 there is no cwd) in the format of 'ls -la'.
1010 This command is mostly useful for interactive sessions. It
1011 is I<not> intended that you try to parse the output string.");
1013 ("ls", (RStringList "listing", [Pathname "directory"]), 6, [],
1014 [InitBasicFS, Always, TestOutputList (
1016 ["touch"; "/newer"];
1017 ["touch"; "/newest"];
1018 ["ls"; "/"]], ["lost+found"; "new"; "newer"; "newest"])],
1019 "list the files in a directory",
1021 List the files in C<directory> (relative to the root directory,
1022 there is no cwd). The '.' and '..' entries are not returned, but
1023 hidden files are shown.
1025 This command is mostly useful for interactive sessions. Programs
1026 should probably use C<guestfs_readdir> instead.");
1028 ("list_devices", (RStringList "devices", []), 7, [],
1029 [InitEmpty, Always, TestOutputListOfDevices (
1030 [["list_devices"]], ["/dev/sda"; "/dev/sdb"; "/dev/sdc"; "/dev/sdd"])],
1031 "list the block devices",
1033 List all the block devices.
1035 The full block device names are returned, eg. C</dev/sda>");
1037 ("list_partitions", (RStringList "partitions", []), 8, [],
1038 [InitBasicFS, Always, TestOutputListOfDevices (
1039 [["list_partitions"]], ["/dev/sda1"]);
1040 InitEmpty, Always, TestOutputListOfDevices (
1041 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1042 ["list_partitions"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1043 "list the partitions",
1045 List all the partitions detected on all block devices.
1047 The full partition device names are returned, eg. C</dev/sda1>
1049 This does not return logical volumes. For that you will need to
1050 call C<guestfs_lvs>.");
1052 ("pvs", (RStringList "physvols", []), 9, [Optional "lvm2"],
1053 [InitBasicFSonLVM, Always, TestOutputListOfDevices (
1054 [["pvs"]], ["/dev/sda1"]);
1055 InitEmpty, Always, TestOutputListOfDevices (
1056 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1057 ["pvcreate"; "/dev/sda1"];
1058 ["pvcreate"; "/dev/sda2"];
1059 ["pvcreate"; "/dev/sda3"];
1060 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1061 "list the LVM physical volumes (PVs)",
1063 List all the physical volumes detected. This is the equivalent
1064 of the L<pvs(8)> command.
1066 This returns a list of just the device names that contain
1067 PVs (eg. C</dev/sda2>).
1069 See also C<guestfs_pvs_full>.");
1071 ("vgs", (RStringList "volgroups", []), 10, [Optional "lvm2"],
1072 [InitBasicFSonLVM, Always, TestOutputList (
1074 InitEmpty, Always, TestOutputList (
1075 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1076 ["pvcreate"; "/dev/sda1"];
1077 ["pvcreate"; "/dev/sda2"];
1078 ["pvcreate"; "/dev/sda3"];
1079 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1080 ["vgcreate"; "VG2"; "/dev/sda3"];
1081 ["vgs"]], ["VG1"; "VG2"])],
1082 "list the LVM volume groups (VGs)",
1084 List all the volumes groups detected. This is the equivalent
1085 of the L<vgs(8)> command.
1087 This returns a list of just the volume group names that were
1088 detected (eg. C<VolGroup00>).
1090 See also C<guestfs_vgs_full>.");
1092 ("lvs", (RStringList "logvols", []), 11, [Optional "lvm2"],
1093 [InitBasicFSonLVM, Always, TestOutputList (
1094 [["lvs"]], ["/dev/VG/LV"]);
1095 InitEmpty, Always, TestOutputList (
1096 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1097 ["pvcreate"; "/dev/sda1"];
1098 ["pvcreate"; "/dev/sda2"];
1099 ["pvcreate"; "/dev/sda3"];
1100 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1101 ["vgcreate"; "VG2"; "/dev/sda3"];
1102 ["lvcreate"; "LV1"; "VG1"; "50"];
1103 ["lvcreate"; "LV2"; "VG1"; "50"];
1104 ["lvcreate"; "LV3"; "VG2"; "50"];
1105 ["lvs"]], ["/dev/VG1/LV1"; "/dev/VG1/LV2"; "/dev/VG2/LV3"])],
1106 "list the LVM logical volumes (LVs)",
1108 List all the logical volumes detected. This is the equivalent
1109 of the L<lvs(8)> command.
1111 This returns a list of the logical volume device names
1112 (eg. C</dev/VolGroup00/LogVol00>).
1114 See also C<guestfs_lvs_full>.");
1116 ("pvs_full", (RStructList ("physvols", "lvm_pv"), []), 12, [Optional "lvm2"],
1117 [], (* XXX how to test? *)
1118 "list the LVM physical volumes (PVs)",
1120 List all the physical volumes detected. This is the equivalent
1121 of the L<pvs(8)> command. The \"full\" version includes all fields.");
1123 ("vgs_full", (RStructList ("volgroups", "lvm_vg"), []), 13, [Optional "lvm2"],
1124 [], (* XXX how to test? *)
1125 "list the LVM volume groups (VGs)",
1127 List all the volumes groups detected. This is the equivalent
1128 of the L<vgs(8)> command. The \"full\" version includes all fields.");
1130 ("lvs_full", (RStructList ("logvols", "lvm_lv"), []), 14, [Optional "lvm2"],
1131 [], (* XXX how to test? *)
1132 "list the LVM logical volumes (LVs)",
1134 List all the logical volumes detected. This is the equivalent
1135 of the L<lvs(8)> command. The \"full\" version includes all fields.");
1137 ("read_lines", (RStringList "lines", [Pathname "path"]), 15, [],
1138 [InitISOFS, Always, TestOutputList (
1139 [["read_lines"; "/known-4"]], ["abc"; "def"; "ghi"]);
1140 InitISOFS, Always, TestOutputList (
1141 [["read_lines"; "/empty"]], [])],
1142 "read file as lines",
1144 Return the contents of the file named C<path>.
1146 The file contents are returned as a list of lines. Trailing
1147 C<LF> and C<CRLF> character sequences are I<not> returned.
1149 Note that this function cannot correctly handle binary files
1150 (specifically, files containing C<\\0> character which is treated
1151 as end of line). For those you need to use the C<guestfs_read_file>
1152 function which has a more complex interface.");
1154 ("aug_init", (RErr, [Pathname "root"; Int "flags"]), 16, [Optional "augeas"],
1155 [], (* XXX Augeas code needs tests. *)
1156 "create a new Augeas handle",
1158 Create a new Augeas handle for editing configuration files.
1159 If there was any previous Augeas handle associated with this
1160 guestfs session, then it is closed.
1162 You must call this before using any other C<guestfs_aug_*>
1165 C<root> is the filesystem root. C<root> must not be NULL,
1168 The flags are the same as the flags defined in
1169 E<lt>augeas.hE<gt>, the logical I<or> of the following
1174 =item C<AUG_SAVE_BACKUP> = 1
1176 Keep the original file with a C<.augsave> extension.
1178 =item C<AUG_SAVE_NEWFILE> = 2
1180 Save changes into a file with extension C<.augnew>, and
1181 do not overwrite original. Overrides C<AUG_SAVE_BACKUP>.
1183 =item C<AUG_TYPE_CHECK> = 4
1185 Typecheck lenses (can be expensive).
1187 =item C<AUG_NO_STDINC> = 8
1189 Do not use standard load path for modules.
1191 =item C<AUG_SAVE_NOOP> = 16
1193 Make save a no-op, just record what would have been changed.
1195 =item C<AUG_NO_LOAD> = 32
1197 Do not load the tree in C<guestfs_aug_init>.
1201 To close the handle, you can call C<guestfs_aug_close>.
1203 To find out more about Augeas, see L<http://augeas.net/>.");
1205 ("aug_close", (RErr, []), 26, [Optional "augeas"],
1206 [], (* XXX Augeas code needs tests. *)
1207 "close the current Augeas handle",
1209 Close the current Augeas handle and free up any resources
1210 used by it. After calling this, you have to call
1211 C<guestfs_aug_init> again before you can use any other
1212 Augeas functions.");
1214 ("aug_defvar", (RInt "nrnodes", [String "name"; OptString "expr"]), 17, [Optional "augeas"],
1215 [], (* XXX Augeas code needs tests. *)
1216 "define an Augeas variable",
1218 Defines an Augeas variable C<name> whose value is the result
1219 of evaluating C<expr>. If C<expr> is NULL, then C<name> is
1222 On success this returns the number of nodes in C<expr>, or
1223 C<0> if C<expr> evaluates to something which is not a nodeset.");
1225 ("aug_defnode", (RStruct ("nrnodescreated", "int_bool"), [String "name"; String "expr"; String "val"]), 18, [Optional "augeas"],
1226 [], (* XXX Augeas code needs tests. *)
1227 "define an Augeas node",
1229 Defines a variable C<name> whose value is the result of
1232 If C<expr> evaluates to an empty nodeset, a node is created,
1233 equivalent to calling C<guestfs_aug_set> C<expr>, C<value>.
1234 C<name> will be the nodeset containing that single node.
1236 On success this returns a pair containing the
1237 number of nodes in the nodeset, and a boolean flag
1238 if a node was created.");
1240 ("aug_get", (RString "val", [String "augpath"]), 19, [Optional "augeas"],
1241 [], (* XXX Augeas code needs tests. *)
1242 "look up the value of an Augeas path",
1244 Look up the value associated with C<path>. If C<path>
1245 matches exactly one node, the C<value> is returned.");
1247 ("aug_set", (RErr, [String "augpath"; String "val"]), 20, [Optional "augeas"],
1248 [], (* XXX Augeas code needs tests. *)
1249 "set Augeas path to value",
1251 Set the value associated with C<path> to C<val>.
1253 In the Augeas API, it is possible to clear a node by setting
1254 the value to NULL. Due to an oversight in the libguestfs API
1255 you cannot do that with this call. Instead you must use the
1256 C<guestfs_aug_clear> call.");
1258 ("aug_insert", (RErr, [String "augpath"; String "label"; Bool "before"]), 21, [Optional "augeas"],
1259 [], (* XXX Augeas code needs tests. *)
1260 "insert a sibling Augeas node",
1262 Create a new sibling C<label> for C<path>, inserting it into
1263 the tree before or after C<path> (depending on the boolean
1266 C<path> must match exactly one existing node in the tree, and
1267 C<label> must be a label, ie. not contain C</>, C<*> or end
1268 with a bracketed index C<[N]>.");
1270 ("aug_rm", (RInt "nrnodes", [String "augpath"]), 22, [Optional "augeas"],
1271 [], (* XXX Augeas code needs tests. *)
1272 "remove an Augeas path",
1274 Remove C<path> and all of its children.
1276 On success this returns the number of entries which were removed.");
1278 ("aug_mv", (RErr, [String "src"; String "dest"]), 23, [Optional "augeas"],
1279 [], (* XXX Augeas code needs tests. *)
1282 Move the node C<src> to C<dest>. C<src> must match exactly
1283 one node. C<dest> is overwritten if it exists.");
1285 ("aug_match", (RStringList "matches", [String "augpath"]), 24, [Optional "augeas"],
1286 [], (* XXX Augeas code needs tests. *)
1287 "return Augeas nodes which match augpath",
1289 Returns a list of paths which match the path expression C<path>.
1290 The returned paths are sufficiently qualified so that they match
1291 exactly one node in the current tree.");
1293 ("aug_save", (RErr, []), 25, [Optional "augeas"],
1294 [], (* XXX Augeas code needs tests. *)
1295 "write all pending Augeas changes to disk",
1297 This writes all pending changes to disk.
1299 The flags which were passed to C<guestfs_aug_init> affect exactly
1300 how files are saved.");
1302 ("aug_load", (RErr, []), 27, [Optional "augeas"],
1303 [], (* XXX Augeas code needs tests. *)
1304 "load files into the tree",
1306 Load files into the tree.
1308 See C<aug_load> in the Augeas documentation for the full gory
1311 ("aug_ls", (RStringList "matches", [String "augpath"]), 28, [Optional "augeas"],
1312 [], (* XXX Augeas code needs tests. *)
1313 "list Augeas nodes under augpath",
1315 This is just a shortcut for listing C<guestfs_aug_match>
1316 C<path/*> and sorting the resulting nodes into alphabetical order.");
1318 ("rm", (RErr, [Pathname "path"]), 29, [],
1319 [InitBasicFS, Always, TestRun
1322 InitBasicFS, Always, TestLastFail
1324 InitBasicFS, Always, TestLastFail
1329 Remove the single file C<path>.");
1331 ("rmdir", (RErr, [Pathname "path"]), 30, [],
1332 [InitBasicFS, Always, TestRun
1335 InitBasicFS, Always, TestLastFail
1336 [["rmdir"; "/new"]];
1337 InitBasicFS, Always, TestLastFail
1339 ["rmdir"; "/new"]]],
1340 "remove a directory",
1342 Remove the single directory C<path>.");
1344 ("rm_rf", (RErr, [Pathname "path"]), 31, [],
1345 [InitBasicFS, Always, TestOutputFalse
1347 ["mkdir"; "/new/foo"];
1348 ["touch"; "/new/foo/bar"];
1350 ["exists"; "/new"]]],
1351 "remove a file or directory recursively",
1353 Remove the file or directory C<path>, recursively removing the
1354 contents if its a directory. This is like the C<rm -rf> shell
1357 ("mkdir", (RErr, [Pathname "path"]), 32, [],
1358 [InitBasicFS, Always, TestOutputTrue
1360 ["is_dir"; "/new"]];
1361 InitBasicFS, Always, TestLastFail
1362 [["mkdir"; "/new/foo/bar"]]],
1363 "create a directory",
1365 Create a directory named C<path>.");
1367 ("mkdir_p", (RErr, [Pathname "path"]), 33, [],
1368 [InitBasicFS, Always, TestOutputTrue
1369 [["mkdir_p"; "/new/foo/bar"];
1370 ["is_dir"; "/new/foo/bar"]];
1371 InitBasicFS, Always, TestOutputTrue
1372 [["mkdir_p"; "/new/foo/bar"];
1373 ["is_dir"; "/new/foo"]];
1374 InitBasicFS, Always, TestOutputTrue
1375 [["mkdir_p"; "/new/foo/bar"];
1376 ["is_dir"; "/new"]];
1377 (* Regression tests for RHBZ#503133: *)
1378 InitBasicFS, Always, TestRun
1380 ["mkdir_p"; "/new"]];
1381 InitBasicFS, Always, TestLastFail
1383 ["mkdir_p"; "/new"]]],
1384 "create a directory and parents",
1386 Create a directory named C<path>, creating any parent directories
1387 as necessary. This is like the C<mkdir -p> shell command.");
1389 ("chmod", (RErr, [Int "mode"; Pathname "path"]), 34, [],
1390 [], (* XXX Need stat command to test *)
1393 Change the mode (permissions) of C<path> to C<mode>. Only
1394 numeric modes are supported.
1396 I<Note>: When using this command from guestfish, C<mode>
1397 by default would be decimal, unless you prefix it with
1398 C<0> to get octal, ie. use C<0700> not C<700>.
1400 The mode actually set is affected by the umask.");
1402 ("chown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 35, [],
1403 [], (* XXX Need stat command to test *)
1404 "change file owner and group",
1406 Change the file owner to C<owner> and group to C<group>.
1408 Only numeric uid and gid are supported. If you want to use
1409 names, you will need to locate and parse the password file
1410 yourself (Augeas support makes this relatively easy).");
1412 ("exists", (RBool "existsflag", [Pathname "path"]), 36, [],
1413 [InitISOFS, Always, TestOutputTrue (
1414 [["exists"; "/empty"]]);
1415 InitISOFS, Always, TestOutputTrue (
1416 [["exists"; "/directory"]])],
1417 "test if file or directory exists",
1419 This returns C<true> if and only if there is a file, directory
1420 (or anything) with the given C<path> name.
1422 See also C<guestfs_is_file>, C<guestfs_is_dir>, C<guestfs_stat>.");
1424 ("is_file", (RBool "fileflag", [Pathname "path"]), 37, [],
1425 [InitISOFS, Always, TestOutputTrue (
1426 [["is_file"; "/known-1"]]);
1427 InitISOFS, Always, TestOutputFalse (
1428 [["is_file"; "/directory"]])],
1429 "test if file exists",
1431 This returns C<true> if and only if there is a file
1432 with the given C<path> name. Note that it returns false for
1433 other objects like directories.
1435 See also C<guestfs_stat>.");
1437 ("is_dir", (RBool "dirflag", [Pathname "path"]), 38, [],
1438 [InitISOFS, Always, TestOutputFalse (
1439 [["is_dir"; "/known-3"]]);
1440 InitISOFS, Always, TestOutputTrue (
1441 [["is_dir"; "/directory"]])],
1442 "test if file exists",
1444 This returns C<true> if and only if there is a directory
1445 with the given C<path> name. Note that it returns false for
1446 other objects like files.
1448 See also C<guestfs_stat>.");
1450 ("pvcreate", (RErr, [Device "device"]), 39, [Optional "lvm2"],
1451 [InitEmpty, Always, TestOutputListOfDevices (
1452 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1453 ["pvcreate"; "/dev/sda1"];
1454 ["pvcreate"; "/dev/sda2"];
1455 ["pvcreate"; "/dev/sda3"];
1456 ["pvs"]], ["/dev/sda1"; "/dev/sda2"; "/dev/sda3"])],
1457 "create an LVM physical volume",
1459 This creates an LVM physical volume on the named C<device>,
1460 where C<device> should usually be a partition name such
1463 ("vgcreate", (RErr, [String "volgroup"; DeviceList "physvols"]), 40, [Optional "lvm2"],
1464 [InitEmpty, Always, TestOutputList (
1465 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1466 ["pvcreate"; "/dev/sda1"];
1467 ["pvcreate"; "/dev/sda2"];
1468 ["pvcreate"; "/dev/sda3"];
1469 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1470 ["vgcreate"; "VG2"; "/dev/sda3"];
1471 ["vgs"]], ["VG1"; "VG2"])],
1472 "create an LVM volume group",
1474 This creates an LVM volume group called C<volgroup>
1475 from the non-empty list of physical volumes C<physvols>.");
1477 ("lvcreate", (RErr, [String "logvol"; String "volgroup"; Int "mbytes"]), 41, [Optional "lvm2"],
1478 [InitEmpty, Always, TestOutputList (
1479 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1480 ["pvcreate"; "/dev/sda1"];
1481 ["pvcreate"; "/dev/sda2"];
1482 ["pvcreate"; "/dev/sda3"];
1483 ["vgcreate"; "VG1"; "/dev/sda1 /dev/sda2"];
1484 ["vgcreate"; "VG2"; "/dev/sda3"];
1485 ["lvcreate"; "LV1"; "VG1"; "50"];
1486 ["lvcreate"; "LV2"; "VG1"; "50"];
1487 ["lvcreate"; "LV3"; "VG2"; "50"];
1488 ["lvcreate"; "LV4"; "VG2"; "50"];
1489 ["lvcreate"; "LV5"; "VG2"; "50"];
1491 ["/dev/VG1/LV1"; "/dev/VG1/LV2";
1492 "/dev/VG2/LV3"; "/dev/VG2/LV4"; "/dev/VG2/LV5"])],
1493 "create an LVM logical volume",
1495 This creates an LVM logical volume called C<logvol>
1496 on the volume group C<volgroup>, with C<size> megabytes.");
1498 ("mkfs", (RErr, [String "fstype"; Device "device"]), 42, [],
1499 [InitEmpty, Always, TestOutput (
1500 [["part_disk"; "/dev/sda"; "mbr"];
1501 ["mkfs"; "ext2"; "/dev/sda1"];
1502 ["mount_options"; ""; "/dev/sda1"; "/"];
1503 ["write"; "/new"; "new file contents"];
1504 ["cat"; "/new"]], "new file contents")],
1505 "make a filesystem",
1507 This creates a filesystem on C<device> (usually a partition
1508 or LVM logical volume). The filesystem type is C<fstype>, for
1511 ("sfdisk", (RErr, [Device "device";
1512 Int "cyls"; Int "heads"; Int "sectors";
1513 StringList "lines"]), 43, [DangerWillRobinson],
1515 "create partitions on a block device",
1517 This is a direct interface to the L<sfdisk(8)> program for creating
1518 partitions on block devices.
1520 C<device> should be a block device, for example C</dev/sda>.
1522 C<cyls>, C<heads> and C<sectors> are the number of cylinders, heads
1523 and sectors on the device, which are passed directly to sfdisk as
1524 the I<-C>, I<-H> and I<-S> parameters. If you pass C<0> for any
1525 of these, then the corresponding parameter is omitted. Usually for
1526 'large' disks, you can just pass C<0> for these, but for small
1527 (floppy-sized) disks, sfdisk (or rather, the kernel) cannot work
1528 out the right geometry and you will need to tell it.
1530 C<lines> is a list of lines that we feed to C<sfdisk>. For more
1531 information refer to the L<sfdisk(8)> manpage.
1533 To create a single partition occupying the whole disk, you would
1534 pass C<lines> as a single element list, when the single element being
1535 the string C<,> (comma).
1537 See also: C<guestfs_sfdisk_l>, C<guestfs_sfdisk_N>,
1538 C<guestfs_part_init>");
1540 ("write_file", (RErr, [Pathname "path"; String "content"; Int "size"]), 44, [ProtocolLimitWarning; DeprecatedBy "write"],
1544 This call creates a file called C<path>. The contents of the
1545 file is the string C<content> (which can contain any 8 bit data),
1546 with length C<size>.
1548 As a special case, if C<size> is C<0>
1549 then the length is calculated using C<strlen> (so in this case
1550 the content cannot contain embedded ASCII NULs).
1552 I<NB.> Owing to a bug, writing content containing ASCII NUL
1553 characters does I<not> work, even if the length is specified.");
1555 ("umount", (RErr, [String "pathordevice"]), 45, [FishAlias "unmount"],
1556 [InitEmpty, Always, TestOutputListOfDevices (
1557 [["part_disk"; "/dev/sda"; "mbr"];
1558 ["mkfs"; "ext2"; "/dev/sda1"];
1559 ["mount_options"; ""; "/dev/sda1"; "/"];
1560 ["mounts"]], ["/dev/sda1"]);
1561 InitEmpty, Always, TestOutputList (
1562 [["part_disk"; "/dev/sda"; "mbr"];
1563 ["mkfs"; "ext2"; "/dev/sda1"];
1564 ["mount_options"; ""; "/dev/sda1"; "/"];
1567 "unmount a filesystem",
1569 This unmounts the given filesystem. The filesystem may be
1570 specified either by its mountpoint (path) or the device which
1571 contains the filesystem.");
1573 ("mounts", (RStringList "devices", []), 46, [],
1574 [InitBasicFS, Always, TestOutputListOfDevices (
1575 [["mounts"]], ["/dev/sda1"])],
1576 "show mounted filesystems",
1578 This returns the list of currently mounted filesystems. It returns
1579 the list of devices (eg. C</dev/sda1>, C</dev/VG/LV>).
1581 Some internal mounts are not shown.
1583 See also: C<guestfs_mountpoints>");
1585 ("umount_all", (RErr, []), 47, [FishAlias "unmount-all"],
1586 [InitBasicFS, Always, TestOutputList (
1589 (* check that umount_all can unmount nested mounts correctly: *)
1590 InitEmpty, Always, TestOutputList (
1591 [["sfdiskM"; "/dev/sda"; ",100 ,200 ,"];
1592 ["mkfs"; "ext2"; "/dev/sda1"];
1593 ["mkfs"; "ext2"; "/dev/sda2"];
1594 ["mkfs"; "ext2"; "/dev/sda3"];
1595 ["mount_options"; ""; "/dev/sda1"; "/"];
1597 ["mount_options"; ""; "/dev/sda2"; "/mp1"];
1598 ["mkdir"; "/mp1/mp2"];
1599 ["mount_options"; ""; "/dev/sda3"; "/mp1/mp2"];
1600 ["mkdir"; "/mp1/mp2/mp3"];
1603 "unmount all filesystems",
1605 This unmounts all mounted filesystems.
1607 Some internal mounts are not unmounted by this call.");
1609 ("lvm_remove_all", (RErr, []), 48, [DangerWillRobinson; Optional "lvm2"],
1611 "remove all LVM LVs, VGs and PVs",
1613 This command removes all LVM logical volumes, volume groups
1614 and physical volumes.");
1616 ("file", (RString "description", [Dev_or_Path "path"]), 49, [],
1617 [InitISOFS, Always, TestOutput (
1618 [["file"; "/empty"]], "empty");
1619 InitISOFS, Always, TestOutput (
1620 [["file"; "/known-1"]], "ASCII text");
1621 InitISOFS, Always, TestLastFail (
1622 [["file"; "/notexists"]])],
1623 "determine file type",
1625 This call uses the standard L<file(1)> command to determine
1626 the type or contents of the file. This also works on devices,
1627 for example to find out whether a partition contains a filesystem.
1629 This call will also transparently look inside various types
1632 The exact command which runs is C<file -zbsL path>. Note in
1633 particular that the filename is not prepended to the output
1634 (the C<-b> option).");
1636 ("command", (RString "output", [StringList "arguments"]), 50, [ProtocolLimitWarning],
1637 [InitBasicFS, Always, TestOutput (
1638 [["upload"; "test-command"; "/test-command"];
1639 ["chmod"; "0o755"; "/test-command"];
1640 ["command"; "/test-command 1"]], "Result1");
1641 InitBasicFS, Always, TestOutput (
1642 [["upload"; "test-command"; "/test-command"];
1643 ["chmod"; "0o755"; "/test-command"];
1644 ["command"; "/test-command 2"]], "Result2\n");
1645 InitBasicFS, Always, TestOutput (
1646 [["upload"; "test-command"; "/test-command"];
1647 ["chmod"; "0o755"; "/test-command"];
1648 ["command"; "/test-command 3"]], "\nResult3");
1649 InitBasicFS, Always, TestOutput (
1650 [["upload"; "test-command"; "/test-command"];
1651 ["chmod"; "0o755"; "/test-command"];
1652 ["command"; "/test-command 4"]], "\nResult4\n");
1653 InitBasicFS, Always, TestOutput (
1654 [["upload"; "test-command"; "/test-command"];
1655 ["chmod"; "0o755"; "/test-command"];
1656 ["command"; "/test-command 5"]], "\nResult5\n\n");
1657 InitBasicFS, Always, TestOutput (
1658 [["upload"; "test-command"; "/test-command"];
1659 ["chmod"; "0o755"; "/test-command"];
1660 ["command"; "/test-command 6"]], "\n\nResult6\n\n");
1661 InitBasicFS, Always, TestOutput (
1662 [["upload"; "test-command"; "/test-command"];
1663 ["chmod"; "0o755"; "/test-command"];
1664 ["command"; "/test-command 7"]], "");
1665 InitBasicFS, Always, TestOutput (
1666 [["upload"; "test-command"; "/test-command"];
1667 ["chmod"; "0o755"; "/test-command"];
1668 ["command"; "/test-command 8"]], "\n");
1669 InitBasicFS, Always, TestOutput (
1670 [["upload"; "test-command"; "/test-command"];
1671 ["chmod"; "0o755"; "/test-command"];
1672 ["command"; "/test-command 9"]], "\n\n");
1673 InitBasicFS, Always, TestOutput (
1674 [["upload"; "test-command"; "/test-command"];
1675 ["chmod"; "0o755"; "/test-command"];
1676 ["command"; "/test-command 10"]], "Result10-1\nResult10-2\n");
1677 InitBasicFS, Always, TestOutput (
1678 [["upload"; "test-command"; "/test-command"];
1679 ["chmod"; "0o755"; "/test-command"];
1680 ["command"; "/test-command 11"]], "Result11-1\nResult11-2");
1681 InitBasicFS, Always, TestLastFail (
1682 [["upload"; "test-command"; "/test-command"];
1683 ["chmod"; "0o755"; "/test-command"];
1684 ["command"; "/test-command"]])],
1685 "run a command from the guest filesystem",
1687 This call runs a command from the guest filesystem. The
1688 filesystem must be mounted, and must contain a compatible
1689 operating system (ie. something Linux, with the same
1690 or compatible processor architecture).
1692 The single parameter is an argv-style list of arguments.
1693 The first element is the name of the program to run.
1694 Subsequent elements are parameters. The list must be
1695 non-empty (ie. must contain a program name). Note that
1696 the command runs directly, and is I<not> invoked via
1697 the shell (see C<guestfs_sh>).
1699 The return value is anything printed to I<stdout> by
1702 If the command returns a non-zero exit status, then
1703 this function returns an error message. The error message
1704 string is the content of I<stderr> from the command.
1706 The C<$PATH> environment variable will contain at least
1707 C</usr/bin> and C</bin>. If you require a program from
1708 another location, you should provide the full path in the
1711 Shared libraries and data files required by the program
1712 must be available on filesystems which are mounted in the
1713 correct places. It is the caller's responsibility to ensure
1714 all filesystems that are needed are mounted at the right
1717 ("command_lines", (RStringList "lines", [StringList "arguments"]), 51, [ProtocolLimitWarning],
1718 [InitBasicFS, Always, TestOutputList (
1719 [["upload"; "test-command"; "/test-command"];
1720 ["chmod"; "0o755"; "/test-command"];
1721 ["command_lines"; "/test-command 1"]], ["Result1"]);
1722 InitBasicFS, Always, TestOutputList (
1723 [["upload"; "test-command"; "/test-command"];
1724 ["chmod"; "0o755"; "/test-command"];
1725 ["command_lines"; "/test-command 2"]], ["Result2"]);
1726 InitBasicFS, Always, TestOutputList (
1727 [["upload"; "test-command"; "/test-command"];
1728 ["chmod"; "0o755"; "/test-command"];
1729 ["command_lines"; "/test-command 3"]], ["";"Result3"]);
1730 InitBasicFS, Always, TestOutputList (
1731 [["upload"; "test-command"; "/test-command"];
1732 ["chmod"; "0o755"; "/test-command"];
1733 ["command_lines"; "/test-command 4"]], ["";"Result4"]);
1734 InitBasicFS, Always, TestOutputList (
1735 [["upload"; "test-command"; "/test-command"];
1736 ["chmod"; "0o755"; "/test-command"];
1737 ["command_lines"; "/test-command 5"]], ["";"Result5";""]);
1738 InitBasicFS, Always, TestOutputList (
1739 [["upload"; "test-command"; "/test-command"];
1740 ["chmod"; "0o755"; "/test-command"];
1741 ["command_lines"; "/test-command 6"]], ["";"";"Result6";""]);
1742 InitBasicFS, Always, TestOutputList (
1743 [["upload"; "test-command"; "/test-command"];
1744 ["chmod"; "0o755"; "/test-command"];
1745 ["command_lines"; "/test-command 7"]], []);
1746 InitBasicFS, Always, TestOutputList (
1747 [["upload"; "test-command"; "/test-command"];
1748 ["chmod"; "0o755"; "/test-command"];
1749 ["command_lines"; "/test-command 8"]], [""]);
1750 InitBasicFS, Always, TestOutputList (
1751 [["upload"; "test-command"; "/test-command"];
1752 ["chmod"; "0o755"; "/test-command"];
1753 ["command_lines"; "/test-command 9"]], ["";""]);
1754 InitBasicFS, Always, TestOutputList (
1755 [["upload"; "test-command"; "/test-command"];
1756 ["chmod"; "0o755"; "/test-command"];
1757 ["command_lines"; "/test-command 10"]], ["Result10-1";"Result10-2"]);
1758 InitBasicFS, Always, TestOutputList (
1759 [["upload"; "test-command"; "/test-command"];
1760 ["chmod"; "0o755"; "/test-command"];
1761 ["command_lines"; "/test-command 11"]], ["Result11-1";"Result11-2"])],
1762 "run a command, returning lines",
1764 This is the same as C<guestfs_command>, but splits the
1765 result into a list of lines.
1767 See also: C<guestfs_sh_lines>");
1769 ("stat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 52, [],
1770 [InitISOFS, Always, TestOutputStruct (
1771 [["stat"; "/empty"]], [CompareWithInt ("size", 0)])],
1772 "get file information",
1774 Returns file information for the given C<path>.
1776 This is the same as the C<stat(2)> system call.");
1778 ("lstat", (RStruct ("statbuf", "stat"), [Pathname "path"]), 53, [],
1779 [InitISOFS, Always, TestOutputStruct (
1780 [["lstat"; "/empty"]], [CompareWithInt ("size", 0)])],
1781 "get file information for a symbolic link",
1783 Returns file information for the given C<path>.
1785 This is the same as C<guestfs_stat> except that if C<path>
1786 is a symbolic link, then the link is stat-ed, not the file it
1789 This is the same as the C<lstat(2)> system call.");
1791 ("statvfs", (RStruct ("statbuf", "statvfs"), [Pathname "path"]), 54, [],
1792 [InitISOFS, Always, TestOutputStruct (
1793 [["statvfs"; "/"]], [CompareWithInt ("namemax", 255)])],
1794 "get file system statistics",
1796 Returns file system statistics for any mounted file system.
1797 C<path> should be a file or directory in the mounted file system
1798 (typically it is the mount point itself, but it doesn't need to be).
1800 This is the same as the C<statvfs(2)> system call.");
1802 ("tune2fs_l", (RHashtable "superblock", [Device "device"]), 55, [],
1804 "get ext2/ext3/ext4 superblock details",
1806 This returns the contents of the ext2, ext3 or ext4 filesystem
1807 superblock on C<device>.
1809 It is the same as running C<tune2fs -l device>. See L<tune2fs(8)>
1810 manpage for more details. The list of fields returned isn't
1811 clearly defined, and depends on both the version of C<tune2fs>
1812 that libguestfs was built against, and the filesystem itself.");
1814 ("blockdev_setro", (RErr, [Device "device"]), 56, [],
1815 [InitEmpty, Always, TestOutputTrue (
1816 [["blockdev_setro"; "/dev/sda"];
1817 ["blockdev_getro"; "/dev/sda"]])],
1818 "set block device to read-only",
1820 Sets the block device named C<device> to read-only.
1822 This uses the L<blockdev(8)> command.");
1824 ("blockdev_setrw", (RErr, [Device "device"]), 57, [],
1825 [InitEmpty, Always, TestOutputFalse (
1826 [["blockdev_setrw"; "/dev/sda"];
1827 ["blockdev_getro"; "/dev/sda"]])],
1828 "set block device to read-write",
1830 Sets the block device named C<device> to read-write.
1832 This uses the L<blockdev(8)> command.");
1834 ("blockdev_getro", (RBool "ro", [Device "device"]), 58, [],
1835 [InitEmpty, Always, TestOutputTrue (
1836 [["blockdev_setro"; "/dev/sda"];
1837 ["blockdev_getro"; "/dev/sda"]])],
1838 "is block device set to read-only",
1840 Returns a boolean indicating if the block device is read-only
1841 (true if read-only, false if not).
1843 This uses the L<blockdev(8)> command.");
1845 ("blockdev_getss", (RInt "sectorsize", [Device "device"]), 59, [],
1846 [InitEmpty, Always, TestOutputInt (
1847 [["blockdev_getss"; "/dev/sda"]], 512)],
1848 "get sectorsize of block device",
1850 This returns the size of sectors on a block device.
1851 Usually 512, but can be larger for modern devices.
1853 (Note, this is not the size in sectors, use C<guestfs_blockdev_getsz>
1856 This uses the L<blockdev(8)> command.");
1858 ("blockdev_getbsz", (RInt "blocksize", [Device "device"]), 60, [],
1859 [InitEmpty, Always, TestOutputInt (
1860 [["blockdev_getbsz"; "/dev/sda"]], 4096)],
1861 "get blocksize of block device",
1863 This returns the block size of a device.
1865 (Note this is different from both I<size in blocks> and
1866 I<filesystem block size>).
1868 This uses the L<blockdev(8)> command.");
1870 ("blockdev_setbsz", (RErr, [Device "device"; Int "blocksize"]), 61, [],
1872 "set blocksize of block device",
1874 This sets the block size of a device.
1876 (Note this is different from both I<size in blocks> and
1877 I<filesystem block size>).
1879 This uses the L<blockdev(8)> command.");
1881 ("blockdev_getsz", (RInt64 "sizeinsectors", [Device "device"]), 62, [],
1882 [InitEmpty, Always, TestOutputInt (
1883 [["blockdev_getsz"; "/dev/sda"]], 1024000)],
1884 "get total size of device in 512-byte sectors",
1886 This returns the size of the device in units of 512-byte sectors
1887 (even if the sectorsize isn't 512 bytes ... weird).
1889 See also C<guestfs_blockdev_getss> for the real sector size of
1890 the device, and C<guestfs_blockdev_getsize64> for the more
1891 useful I<size in bytes>.
1893 This uses the L<blockdev(8)> command.");
1895 ("blockdev_getsize64", (RInt64 "sizeinbytes", [Device "device"]), 63, [],
1896 [InitEmpty, Always, TestOutputInt (
1897 [["blockdev_getsize64"; "/dev/sda"]], 524288000)],
1898 "get total size of device in bytes",
1900 This returns the size of the device in bytes.
1902 See also C<guestfs_blockdev_getsz>.
1904 This uses the L<blockdev(8)> command.");
1906 ("blockdev_flushbufs", (RErr, [Device "device"]), 64, [],
1907 [InitEmpty, Always, TestRun
1908 [["blockdev_flushbufs"; "/dev/sda"]]],
1909 "flush device buffers",
1911 This tells the kernel to flush internal buffers associated
1914 This uses the L<blockdev(8)> command.");
1916 ("blockdev_rereadpt", (RErr, [Device "device"]), 65, [],
1917 [InitEmpty, Always, TestRun
1918 [["blockdev_rereadpt"; "/dev/sda"]]],
1919 "reread partition table",
1921 Reread the partition table on C<device>.
1923 This uses the L<blockdev(8)> command.");
1925 ("upload", (RErr, [FileIn "filename"; Dev_or_Path "remotefilename"]), 66, [],
1926 [InitBasicFS, Always, TestOutput (
1927 (* Pick a file from cwd which isn't likely to change. *)
1928 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1929 ["checksum"; "md5"; "/COPYING.LIB"]],
1930 Digest.to_hex (Digest.file "COPYING.LIB"))],
1931 "upload a file from the local machine",
1933 Upload local file C<filename> to C<remotefilename> on the
1936 C<filename> can also be a named pipe.
1938 See also C<guestfs_download>.");
1940 ("download", (RErr, [Dev_or_Path "remotefilename"; FileOut "filename"]), 67, [],
1941 [InitBasicFS, Always, TestOutput (
1942 (* Pick a file from cwd which isn't likely to change. *)
1943 [["upload"; "../COPYING.LIB"; "/COPYING.LIB"];
1944 ["download"; "/COPYING.LIB"; "testdownload.tmp"];
1945 ["upload"; "testdownload.tmp"; "/upload"];
1946 ["checksum"; "md5"; "/upload"]],
1947 Digest.to_hex (Digest.file "COPYING.LIB"))],
1948 "download a file to the local machine",
1950 Download file C<remotefilename> and save it as C<filename>
1951 on the local machine.
1953 C<filename> can also be a named pipe.
1955 See also C<guestfs_upload>, C<guestfs_cat>.");
1957 ("checksum", (RString "checksum", [String "csumtype"; Pathname "path"]), 68, [],
1958 [InitISOFS, Always, TestOutput (
1959 [["checksum"; "crc"; "/known-3"]], "2891671662");
1960 InitISOFS, Always, TestLastFail (
1961 [["checksum"; "crc"; "/notexists"]]);
1962 InitISOFS, Always, TestOutput (
1963 [["checksum"; "md5"; "/known-3"]], "46d6ca27ee07cdc6fa99c2e138cc522c");
1964 InitISOFS, Always, TestOutput (
1965 [["checksum"; "sha1"; "/known-3"]], "b7ebccc3ee418311091c3eda0a45b83c0a770f15");
1966 InitISOFS, Always, TestOutput (
1967 [["checksum"; "sha224"; "/known-3"]], "d2cd1774b28f3659c14116be0a6dc2bb5c4b350ce9cd5defac707741");
1968 InitISOFS, Always, TestOutput (
1969 [["checksum"; "sha256"; "/known-3"]], "75bb71b90cd20cb13f86d2bea8dad63ac7194e7517c3b52b8d06ff52d3487d30");
1970 InitISOFS, Always, TestOutput (
1971 [["checksum"; "sha384"; "/known-3"]], "5fa7883430f357b5d7b7271d3a1d2872b51d73cba72731de6863d3dea55f30646af2799bef44d5ea776a5ec7941ac640");
1972 InitISOFS, Always, TestOutput (
1973 [["checksum"; "sha512"; "/known-3"]], "2794062c328c6b216dca90443b7f7134c5f40e56bd0ed7853123275a09982a6f992e6ca682f9d2fba34a4c5e870d8fe077694ff831e3032a004ee077e00603f6");
1974 (* Test for RHBZ#579608, absolute symbolic links. *)
1975 InitISOFS, Always, TestOutput (
1976 [["checksum"; "sha512"; "/abssymlink"]], "5f57d0639bc95081c53afc63a449403883818edc64da48930ad6b1a4fb49be90404686877743fbcd7c99811f3def7df7bc22635c885c6a8cf79c806b43451c1a")],
1977 "compute MD5, SHAx or CRC checksum of file",
1979 This call computes the MD5, SHAx or CRC checksum of the
1982 The type of checksum to compute is given by the C<csumtype>
1983 parameter which must have one of the following values:
1989 Compute the cyclic redundancy check (CRC) specified by POSIX
1990 for the C<cksum> command.
1994 Compute the MD5 hash (using the C<md5sum> program).
1998 Compute the SHA1 hash (using the C<sha1sum> program).
2002 Compute the SHA224 hash (using the C<sha224sum> program).
2006 Compute the SHA256 hash (using the C<sha256sum> program).
2010 Compute the SHA384 hash (using the C<sha384sum> program).
2014 Compute the SHA512 hash (using the C<sha512sum> program).
2018 The checksum is returned as a printable string.
2020 To get the checksum for a device, use C<guestfs_checksum_device>.
2022 To get the checksums for many files, use C<guestfs_checksums_out>.");
2024 ("tar_in", (RErr, [FileIn "tarfile"; Pathname "directory"]), 69, [],
2025 [InitBasicFS, Always, TestOutput (
2026 [["tar_in"; "../images/helloworld.tar"; "/"];
2027 ["cat"; "/hello"]], "hello\n")],
2028 "unpack tarfile to directory",
2030 This command uploads and unpacks local file C<tarfile> (an
2031 I<uncompressed> tar file) into C<directory>.
2033 To upload a compressed tarball, use C<guestfs_tgz_in>
2034 or C<guestfs_txz_in>.");
2036 ("tar_out", (RErr, [String "directory"; FileOut "tarfile"]), 70, [],
2038 "pack directory into tarfile",
2040 This command packs the contents of C<directory> and downloads
2041 it to local file C<tarfile>.
2043 To download a compressed tarball, use C<guestfs_tgz_out>
2044 or C<guestfs_txz_out>.");
2046 ("tgz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 71, [],
2047 [InitBasicFS, Always, TestOutput (
2048 [["tgz_in"; "../images/helloworld.tar.gz"; "/"];
2049 ["cat"; "/hello"]], "hello\n")],
2050 "unpack compressed tarball to directory",
2052 This command uploads and unpacks local file C<tarball> (a
2053 I<gzip compressed> tar file) into C<directory>.
2055 To upload an uncompressed tarball, use C<guestfs_tar_in>.");
2057 ("tgz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 72, [],
2059 "pack directory into compressed tarball",
2061 This command packs the contents of C<directory> and downloads
2062 it to local file C<tarball>.
2064 To download an uncompressed tarball, use C<guestfs_tar_out>.");
2066 ("mount_ro", (RErr, [Device "device"; String "mountpoint"]), 73, [],
2067 [InitBasicFS, Always, TestLastFail (
2069 ["mount_ro"; "/dev/sda1"; "/"];
2070 ["touch"; "/new"]]);
2071 InitBasicFS, Always, TestOutput (
2072 [["write"; "/new"; "data"];
2074 ["mount_ro"; "/dev/sda1"; "/"];
2075 ["cat"; "/new"]], "data")],
2076 "mount a guest disk, read-only",
2078 This is the same as the C<guestfs_mount> command, but it
2079 mounts the filesystem with the read-only (I<-o ro>) flag.");
2081 ("mount_options", (RErr, [String "options"; Device "device"; String "mountpoint"]), 74, [],
2083 "mount a guest disk with mount options",
2085 This is the same as the C<guestfs_mount> command, but it
2086 allows you to set the mount options as for the
2087 L<mount(8)> I<-o> flag.
2089 If the C<options> parameter is an empty string, then
2090 no options are passed (all options default to whatever
2091 the filesystem uses).");
2093 ("mount_vfs", (RErr, [String "options"; String "vfstype"; Device "device"; String "mountpoint"]), 75, [],
2095 "mount a guest disk with mount options and vfstype",
2097 This is the same as the C<guestfs_mount> command, but it
2098 allows you to set both the mount options and the vfstype
2099 as for the L<mount(8)> I<-o> and I<-t> flags.");
2101 ("debug", (RString "result", [String "subcmd"; StringList "extraargs"]), 76, [],
2103 "debugging and internals",
2105 The C<guestfs_debug> command exposes some internals of
2106 C<guestfsd> (the guestfs daemon) that runs inside the
2109 There is no comprehensive help for this command. You have
2110 to look at the file C<daemon/debug.c> in the libguestfs source
2111 to find out what you can do.");
2113 ("lvremove", (RErr, [Device "device"]), 77, [Optional "lvm2"],
2114 [InitEmpty, Always, TestOutputList (
2115 [["part_disk"; "/dev/sda"; "mbr"];
2116 ["pvcreate"; "/dev/sda1"];
2117 ["vgcreate"; "VG"; "/dev/sda1"];
2118 ["lvcreate"; "LV1"; "VG"; "50"];
2119 ["lvcreate"; "LV2"; "VG"; "50"];
2120 ["lvremove"; "/dev/VG/LV1"];
2121 ["lvs"]], ["/dev/VG/LV2"]);
2122 InitEmpty, Always, TestOutputList (
2123 [["part_disk"; "/dev/sda"; "mbr"];
2124 ["pvcreate"; "/dev/sda1"];
2125 ["vgcreate"; "VG"; "/dev/sda1"];
2126 ["lvcreate"; "LV1"; "VG"; "50"];
2127 ["lvcreate"; "LV2"; "VG"; "50"];
2128 ["lvremove"; "/dev/VG"];
2130 InitEmpty, Always, TestOutputList (
2131 [["part_disk"; "/dev/sda"; "mbr"];
2132 ["pvcreate"; "/dev/sda1"];
2133 ["vgcreate"; "VG"; "/dev/sda1"];
2134 ["lvcreate"; "LV1"; "VG"; "50"];
2135 ["lvcreate"; "LV2"; "VG"; "50"];
2136 ["lvremove"; "/dev/VG"];
2138 "remove an LVM logical volume",
2140 Remove an LVM logical volume C<device>, where C<device> is
2141 the path to the LV, such as C</dev/VG/LV>.
2143 You can also remove all LVs in a volume group by specifying
2144 the VG name, C</dev/VG>.");
2146 ("vgremove", (RErr, [String "vgname"]), 78, [Optional "lvm2"],
2147 [InitEmpty, Always, TestOutputList (
2148 [["part_disk"; "/dev/sda"; "mbr"];
2149 ["pvcreate"; "/dev/sda1"];
2150 ["vgcreate"; "VG"; "/dev/sda1"];
2151 ["lvcreate"; "LV1"; "VG"; "50"];
2152 ["lvcreate"; "LV2"; "VG"; "50"];
2155 InitEmpty, Always, TestOutputList (
2156 [["part_disk"; "/dev/sda"; "mbr"];
2157 ["pvcreate"; "/dev/sda1"];
2158 ["vgcreate"; "VG"; "/dev/sda1"];
2159 ["lvcreate"; "LV1"; "VG"; "50"];
2160 ["lvcreate"; "LV2"; "VG"; "50"];
2163 "remove an LVM volume group",
2165 Remove an LVM volume group C<vgname>, (for example C<VG>).
2167 This also forcibly removes all logical volumes in the volume
2170 ("pvremove", (RErr, [Device "device"]), 79, [Optional "lvm2"],
2171 [InitEmpty, Always, TestOutputListOfDevices (
2172 [["part_disk"; "/dev/sda"; "mbr"];
2173 ["pvcreate"; "/dev/sda1"];
2174 ["vgcreate"; "VG"; "/dev/sda1"];
2175 ["lvcreate"; "LV1"; "VG"; "50"];
2176 ["lvcreate"; "LV2"; "VG"; "50"];
2178 ["pvremove"; "/dev/sda1"];
2180 InitEmpty, Always, TestOutputListOfDevices (
2181 [["part_disk"; "/dev/sda"; "mbr"];
2182 ["pvcreate"; "/dev/sda1"];
2183 ["vgcreate"; "VG"; "/dev/sda1"];
2184 ["lvcreate"; "LV1"; "VG"; "50"];
2185 ["lvcreate"; "LV2"; "VG"; "50"];
2187 ["pvremove"; "/dev/sda1"];
2189 InitEmpty, Always, TestOutputListOfDevices (
2190 [["part_disk"; "/dev/sda"; "mbr"];
2191 ["pvcreate"; "/dev/sda1"];
2192 ["vgcreate"; "VG"; "/dev/sda1"];
2193 ["lvcreate"; "LV1"; "VG"; "50"];
2194 ["lvcreate"; "LV2"; "VG"; "50"];
2196 ["pvremove"; "/dev/sda1"];
2198 "remove an LVM physical volume",
2200 This wipes a physical volume C<device> so that LVM will no longer
2203 The implementation uses the C<pvremove> command which refuses to
2204 wipe physical volumes that contain any volume groups, so you have
2205 to remove those first.");
2207 ("set_e2label", (RErr, [Device "device"; String "label"]), 80, [],
2208 [InitBasicFS, Always, TestOutput (
2209 [["set_e2label"; "/dev/sda1"; "testlabel"];
2210 ["get_e2label"; "/dev/sda1"]], "testlabel")],
2211 "set the ext2/3/4 filesystem label",
2213 This sets the ext2/3/4 filesystem label of the filesystem on
2214 C<device> to C<label>. Filesystem labels are limited to
2217 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2label>
2218 to return the existing label on a filesystem.");
2220 ("get_e2label", (RString "label", [Device "device"]), 81, [],
2222 "get the ext2/3/4 filesystem label",
2224 This returns the ext2/3/4 filesystem label of the filesystem on
2227 ("set_e2uuid", (RErr, [Device "device"; String "uuid"]), 82, [],
2228 (let uuid = uuidgen () in
2229 [InitBasicFS, Always, TestOutput (
2230 [["set_e2uuid"; "/dev/sda1"; uuid];
2231 ["get_e2uuid"; "/dev/sda1"]], uuid);
2232 InitBasicFS, Always, TestOutput (
2233 [["set_e2uuid"; "/dev/sda1"; "clear"];
2234 ["get_e2uuid"; "/dev/sda1"]], "");
2235 (* We can't predict what UUIDs will be, so just check the commands run. *)
2236 InitBasicFS, Always, TestRun (
2237 [["set_e2uuid"; "/dev/sda1"; "random"]]);
2238 InitBasicFS, Always, TestRun (
2239 [["set_e2uuid"; "/dev/sda1"; "time"]])]),
2240 "set the ext2/3/4 filesystem UUID",
2242 This sets the ext2/3/4 filesystem UUID of the filesystem on
2243 C<device> to C<uuid>. The format of the UUID and alternatives
2244 such as C<clear>, C<random> and C<time> are described in the
2245 L<tune2fs(8)> manpage.
2247 You can use either C<guestfs_tune2fs_l> or C<guestfs_get_e2uuid>
2248 to return the existing UUID of a filesystem.");
2250 ("get_e2uuid", (RString "uuid", [Device "device"]), 83, [],
2252 "get the ext2/3/4 filesystem UUID",
2254 This returns the ext2/3/4 filesystem UUID of the filesystem on
2257 ("fsck", (RInt "status", [String "fstype"; Device "device"]), 84, [FishOutput FishOutputHexadecimal],
2258 [InitBasicFS, Always, TestOutputInt (
2259 [["umount"; "/dev/sda1"];
2260 ["fsck"; "ext2"; "/dev/sda1"]], 0);
2261 InitBasicFS, Always, TestOutputInt (
2262 [["umount"; "/dev/sda1"];
2263 ["zero"; "/dev/sda1"];
2264 ["fsck"; "ext2"; "/dev/sda1"]], 8)],
2265 "run the filesystem checker",
2267 This runs the filesystem checker (fsck) on C<device> which
2268 should have filesystem type C<fstype>.
2270 The returned integer is the status. See L<fsck(8)> for the
2271 list of status codes from C<fsck>.
2279 Multiple status codes can be summed together.
2283 A non-zero return code can mean \"success\", for example if
2284 errors have been corrected on the filesystem.
2288 Checking or repairing NTFS volumes is not supported
2293 This command is entirely equivalent to running C<fsck -a -t fstype device>.");
2295 ("zero", (RErr, [Device "device"]), 85, [],
2296 [InitBasicFS, Always, TestOutput (
2297 [["umount"; "/dev/sda1"];
2298 ["zero"; "/dev/sda1"];
2299 ["file"; "/dev/sda1"]], "data")],
2300 "write zeroes to the device",
2302 This command writes zeroes over the first few blocks of C<device>.
2304 How many blocks are zeroed isn't specified (but it's I<not> enough
2305 to securely wipe the device). It should be sufficient to remove
2306 any partition tables, filesystem superblocks and so on.
2308 See also: C<guestfs_zero_device>, C<guestfs_scrub_device>.");
2310 ("grub_install", (RErr, [Pathname "root"; Device "device"]), 86, [],
2311 (* Test disabled because grub-install incompatible with virtio-blk driver.
2312 * See also: https://bugzilla.redhat.com/show_bug.cgi?id=479760
2314 [InitBasicFS, Disabled, TestOutputTrue (
2315 [["grub_install"; "/"; "/dev/sda1"];
2316 ["is_dir"; "/boot"]])],
2319 This command installs GRUB (the Grand Unified Bootloader) on
2320 C<device>, with the root directory being C<root>.");
2322 ("cp", (RErr, [Pathname "src"; Pathname "dest"]), 87, [],
2323 [InitBasicFS, Always, TestOutput (
2324 [["write"; "/old"; "file content"];
2325 ["cp"; "/old"; "/new"];
2326 ["cat"; "/new"]], "file content");
2327 InitBasicFS, Always, TestOutputTrue (
2328 [["write"; "/old"; "file content"];
2329 ["cp"; "/old"; "/new"];
2330 ["is_file"; "/old"]]);
2331 InitBasicFS, Always, TestOutput (
2332 [["write"; "/old"; "file content"];
2334 ["cp"; "/old"; "/dir/new"];
2335 ["cat"; "/dir/new"]], "file content")],
2338 This copies a file from C<src> to C<dest> where C<dest> is
2339 either a destination filename or destination directory.");
2341 ("cp_a", (RErr, [Pathname "src"; Pathname "dest"]), 88, [],
2342 [InitBasicFS, Always, TestOutput (
2343 [["mkdir"; "/olddir"];
2344 ["mkdir"; "/newdir"];
2345 ["write"; "/olddir/file"; "file content"];
2346 ["cp_a"; "/olddir"; "/newdir"];
2347 ["cat"; "/newdir/olddir/file"]], "file content")],
2348 "copy a file or directory recursively",
2350 This copies a file or directory from C<src> to C<dest>
2351 recursively using the C<cp -a> command.");
2353 ("mv", (RErr, [Pathname "src"; Pathname "dest"]), 89, [],
2354 [InitBasicFS, Always, TestOutput (
2355 [["write"; "/old"; "file content"];
2356 ["mv"; "/old"; "/new"];
2357 ["cat"; "/new"]], "file content");
2358 InitBasicFS, Always, TestOutputFalse (
2359 [["write"; "/old"; "file content"];
2360 ["mv"; "/old"; "/new"];
2361 ["is_file"; "/old"]])],
2364 This moves a file from C<src> to C<dest> where C<dest> is
2365 either a destination filename or destination directory.");
2367 ("drop_caches", (RErr, [Int "whattodrop"]), 90, [],
2368 [InitEmpty, Always, TestRun (
2369 [["drop_caches"; "3"]])],
2370 "drop kernel page cache, dentries and inodes",
2372 This instructs the guest kernel to drop its page cache,
2373 and/or dentries and inode caches. The parameter C<whattodrop>
2374 tells the kernel what precisely to drop, see
2375 L<http://linux-mm.org/Drop_Caches>
2377 Setting C<whattodrop> to 3 should drop everything.
2379 This automatically calls L<sync(2)> before the operation,
2380 so that the maximum guest memory is freed.");
2382 ("dmesg", (RString "kmsgs", []), 91, [],
2383 [InitEmpty, Always, TestRun (
2385 "return kernel messages",
2387 This returns the kernel messages (C<dmesg> output) from
2388 the guest kernel. This is sometimes useful for extended
2389 debugging of problems.
2391 Another way to get the same information is to enable
2392 verbose messages with C<guestfs_set_verbose> or by setting
2393 the environment variable C<LIBGUESTFS_DEBUG=1> before
2394 running the program.");
2396 ("ping_daemon", (RErr, []), 92, [],
2397 [InitEmpty, Always, TestRun (
2398 [["ping_daemon"]])],
2399 "ping the guest daemon",
2401 This is a test probe into the guestfs daemon running inside
2402 the qemu subprocess. Calling this function checks that the
2403 daemon responds to the ping message, without affecting the daemon
2404 or attached block device(s) in any other way.");
2406 ("equal", (RBool "equality", [Pathname "file1"; Pathname "file2"]), 93, [],
2407 [InitBasicFS, Always, TestOutputTrue (
2408 [["write"; "/file1"; "contents of a file"];
2409 ["cp"; "/file1"; "/file2"];
2410 ["equal"; "/file1"; "/file2"]]);
2411 InitBasicFS, Always, TestOutputFalse (
2412 [["write"; "/file1"; "contents of a file"];
2413 ["write"; "/file2"; "contents of another file"];
2414 ["equal"; "/file1"; "/file2"]]);
2415 InitBasicFS, Always, TestLastFail (
2416 [["equal"; "/file1"; "/file2"]])],
2417 "test if two files have equal contents",
2419 This compares the two files C<file1> and C<file2> and returns
2420 true if their content is exactly equal, or false otherwise.
2422 The external L<cmp(1)> program is used for the comparison.");
2424 ("strings", (RStringList "stringsout", [Pathname "path"]), 94, [ProtocolLimitWarning],
2425 [InitISOFS, Always, TestOutputList (
2426 [["strings"; "/known-5"]], ["abcdefghi"; "jklmnopqr"]);
2427 InitISOFS, Always, TestOutputList (
2428 [["strings"; "/empty"]], []);
2429 (* Test for RHBZ#579608, absolute symbolic links. *)
2430 InitISOFS, Always, TestRun (
2431 [["strings"; "/abssymlink"]])],
2432 "print the printable strings in a file",
2434 This runs the L<strings(1)> command on a file and returns
2435 the list of printable strings found.");
2437 ("strings_e", (RStringList "stringsout", [String "encoding"; Pathname "path"]), 95, [ProtocolLimitWarning],
2438 [InitISOFS, Always, TestOutputList (
2439 [["strings_e"; "b"; "/known-5"]], []);
2440 InitBasicFS, Always, TestOutputList (
2441 [["write"; "/new"; "\000h\000e\000l\000l\000o\000\n\000w\000o\000r\000l\000d\000\n"];
2442 ["strings_e"; "b"; "/new"]], ["hello"; "world"])],
2443 "print the printable strings in a file",
2445 This is like the C<guestfs_strings> command, but allows you to
2446 specify the encoding of strings that are looked for in
2447 the source file C<path>.
2449 Allowed encodings are:
2455 Single 7-bit-byte characters like ASCII and the ASCII-compatible
2456 parts of ISO-8859-X (this is what C<guestfs_strings> uses).
2460 Single 8-bit-byte characters.
2464 16-bit big endian strings such as those encoded in
2465 UTF-16BE or UCS-2BE.
2467 =item l (lower case letter L)
2469 16-bit little endian such as UTF-16LE and UCS-2LE.
2470 This is useful for examining binaries in Windows guests.
2474 32-bit big endian such as UCS-4BE.
2478 32-bit little endian such as UCS-4LE.
2482 The returned strings are transcoded to UTF-8.");
2484 ("hexdump", (RString "dump", [Pathname "path"]), 96, [ProtocolLimitWarning],
2485 [InitISOFS, Always, TestOutput (
2486 [["hexdump"; "/known-4"]], "00000000 61 62 63 0a 64 65 66 0a 67 68 69 |abc.def.ghi|\n0000000b\n");
2487 (* Test for RHBZ#501888c2 regression which caused large hexdump
2488 * commands to segfault.
2490 InitISOFS, Always, TestRun (
2491 [["hexdump"; "/100krandom"]]);
2492 (* Test for RHBZ#579608, absolute symbolic links. *)
2493 InitISOFS, Always, TestRun (
2494 [["hexdump"; "/abssymlink"]])],
2495 "dump a file in hexadecimal",
2497 This runs C<hexdump -C> on the given C<path>. The result is
2498 the human-readable, canonical hex dump of the file.");
2500 ("zerofree", (RErr, [Device "device"]), 97, [Optional "zerofree"],
2501 [InitNone, Always, TestOutput (
2502 [["part_disk"; "/dev/sda"; "mbr"];
2503 ["mkfs"; "ext3"; "/dev/sda1"];
2504 ["mount_options"; ""; "/dev/sda1"; "/"];
2505 ["write"; "/new"; "test file"];
2506 ["umount"; "/dev/sda1"];
2507 ["zerofree"; "/dev/sda1"];
2508 ["mount_options"; ""; "/dev/sda1"; "/"];
2509 ["cat"; "/new"]], "test file")],
2510 "zero unused inodes and disk blocks on ext2/3 filesystem",
2512 This runs the I<zerofree> program on C<device>. This program
2513 claims to zero unused inodes and disk blocks on an ext2/3
2514 filesystem, thus making it possible to compress the filesystem
2517 You should B<not> run this program if the filesystem is
2520 It is possible that using this program can damage the filesystem
2521 or data on the filesystem.");
2523 ("pvresize", (RErr, [Device "device"]), 98, [Optional "lvm2"],
2525 "resize an LVM physical volume",
2527 This resizes (expands or shrinks) an existing LVM physical
2528 volume to match the new size of the underlying device.");
2530 ("sfdisk_N", (RErr, [Device "device"; Int "partnum";
2531 Int "cyls"; Int "heads"; Int "sectors";
2532 String "line"]), 99, [DangerWillRobinson],
2534 "modify a single partition on a block device",
2536 This runs L<sfdisk(8)> option to modify just the single
2537 partition C<n> (note: C<n> counts from 1).
2539 For other parameters, see C<guestfs_sfdisk>. You should usually
2540 pass C<0> for the cyls/heads/sectors parameters.
2542 See also: C<guestfs_part_add>");
2544 ("sfdisk_l", (RString "partitions", [Device "device"]), 100, [],
2546 "display the partition table",
2548 This displays the partition table on C<device>, in the
2549 human-readable output of the L<sfdisk(8)> command. It is
2550 not intended to be parsed.
2552 See also: C<guestfs_part_list>");
2554 ("sfdisk_kernel_geometry", (RString "partitions", [Device "device"]), 101, [],
2556 "display the kernel geometry",
2558 This displays the kernel's idea of the geometry of C<device>.
2560 The result is in human-readable format, and not designed to
2563 ("sfdisk_disk_geometry", (RString "partitions", [Device "device"]), 102, [],
2565 "display the disk geometry from the partition table",
2567 This displays the disk geometry of C<device> read from the
2568 partition table. Especially in the case where the underlying
2569 block device has been resized, this can be different from the
2570 kernel's idea of the geometry (see C<guestfs_sfdisk_kernel_geometry>).
2572 The result is in human-readable format, and not designed to
2575 ("vg_activate_all", (RErr, [Bool "activate"]), 103, [Optional "lvm2"],
2577 "activate or deactivate all volume groups",
2579 This command activates or (if C<activate> is false) deactivates
2580 all logical volumes in all volume groups.
2581 If activated, then they are made known to the
2582 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2583 then those devices disappear.
2585 This command is the same as running C<vgchange -a y|n>");
2587 ("vg_activate", (RErr, [Bool "activate"; StringList "volgroups"]), 104, [Optional "lvm2"],
2589 "activate or deactivate some volume groups",
2591 This command activates or (if C<activate> is false) deactivates
2592 all logical volumes in the listed volume groups C<volgroups>.
2593 If activated, then they are made known to the
2594 kernel, ie. they appear as C</dev/mapper> devices. If deactivated,
2595 then those devices disappear.
2597 This command is the same as running C<vgchange -a y|n volgroups...>
2599 Note that if C<volgroups> is an empty list then B<all> volume groups
2600 are activated or deactivated.");
2602 ("lvresize", (RErr, [Device "device"; Int "mbytes"]), 105, [Optional "lvm2"],
2603 [InitNone, Always, TestOutput (
2604 [["part_disk"; "/dev/sda"; "mbr"];
2605 ["pvcreate"; "/dev/sda1"];
2606 ["vgcreate"; "VG"; "/dev/sda1"];
2607 ["lvcreate"; "LV"; "VG"; "10"];
2608 ["mkfs"; "ext2"; "/dev/VG/LV"];
2609 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2610 ["write"; "/new"; "test content"];
2612 ["lvresize"; "/dev/VG/LV"; "20"];
2613 ["e2fsck_f"; "/dev/VG/LV"];
2614 ["resize2fs"; "/dev/VG/LV"];
2615 ["mount_options"; ""; "/dev/VG/LV"; "/"];
2616 ["cat"; "/new"]], "test content");
2617 InitNone, Always, TestRun (
2618 (* Make an LV smaller to test RHBZ#587484. *)
2619 [["part_disk"; "/dev/sda"; "mbr"];
2620 ["pvcreate"; "/dev/sda1"];
2621 ["vgcreate"; "VG"; "/dev/sda1"];
2622 ["lvcreate"; "LV"; "VG"; "20"];
2623 ["lvresize"; "/dev/VG/LV"; "10"]])],
2624 "resize an LVM logical volume",
2626 This resizes (expands or shrinks) an existing LVM logical
2627 volume to C<mbytes>. When reducing, data in the reduced part
2630 ("resize2fs", (RErr, [Device "device"]), 106, [],
2631 [], (* lvresize tests this *)
2632 "resize an ext2/ext3 filesystem",
2634 This resizes an ext2 or ext3 filesystem to match the size of
2635 the underlying device.
2637 I<Note:> It is sometimes required that you run C<guestfs_e2fsck_f>
2638 on the C<device> before calling this command. For unknown reasons
2639 C<resize2fs> sometimes gives an error about this and sometimes not.
2640 In any case, it is always safe to call C<guestfs_e2fsck_f> before
2641 calling this function.");
2643 ("find", (RStringList "names", [Pathname "directory"]), 107, [ProtocolLimitWarning],
2644 [InitBasicFS, Always, TestOutputList (
2645 [["find"; "/"]], ["lost+found"]);
2646 InitBasicFS, Always, TestOutputList (
2650 ["find"; "/"]], ["a"; "b"; "b/c"; "lost+found"]);
2651 InitBasicFS, Always, TestOutputList (
2652 [["mkdir_p"; "/a/b/c"];
2653 ["touch"; "/a/b/c/d"];
2654 ["find"; "/a/b/"]], ["c"; "c/d"])],
2655 "find all files and directories",
2657 This command lists out all files and directories, recursively,
2658 starting at C<directory>. It is essentially equivalent to
2659 running the shell command C<find directory -print> but some
2660 post-processing happens on the output, described below.
2662 This returns a list of strings I<without any prefix>. Thus
2663 if the directory structure was:
2669 then the returned list from C<guestfs_find> C</tmp> would be
2677 If C<directory> is not a directory, then this command returns
2680 The returned list is sorted.
2682 See also C<guestfs_find0>.");
2684 ("e2fsck_f", (RErr, [Device "device"]), 108, [],
2685 [], (* lvresize tests this *)
2686 "check an ext2/ext3 filesystem",
2688 This runs C<e2fsck -p -f device>, ie. runs the ext2/ext3
2689 filesystem checker on C<device>, noninteractively (C<-p>),
2690 even if the filesystem appears to be clean (C<-f>).
2692 This command is only needed because of C<guestfs_resize2fs>
2693 (q.v.). Normally you should use C<guestfs_fsck>.");
2695 ("sleep", (RErr, [Int "secs"]), 109, [],
2696 [InitNone, Always, TestRun (
2698 "sleep for some seconds",
2700 Sleep for C<secs> seconds.");
2702 ("ntfs_3g_probe", (RInt "status", [Bool "rw"; Device "device"]), 110, [Optional "ntfs3g"],
2703 [InitNone, Always, TestOutputInt (
2704 [["part_disk"; "/dev/sda"; "mbr"];
2705 ["mkfs"; "ntfs"; "/dev/sda1"];
2706 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 0);
2707 InitNone, Always, TestOutputInt (
2708 [["part_disk"; "/dev/sda"; "mbr"];
2709 ["mkfs"; "ext2"; "/dev/sda1"];
2710 ["ntfs_3g_probe"; "true"; "/dev/sda1"]], 12)],
2711 "probe NTFS volume",
2713 This command runs the L<ntfs-3g.probe(8)> command which probes
2714 an NTFS C<device> for mountability. (Not all NTFS volumes can
2715 be mounted read-write, and some cannot be mounted at all).
2717 C<rw> is a boolean flag. Set it to true if you want to test
2718 if the volume can be mounted read-write. Set it to false if
2719 you want to test if the volume can be mounted read-only.
2721 The return value is an integer which C<0> if the operation
2722 would succeed, or some non-zero value documented in the
2723 L<ntfs-3g.probe(8)> manual page.");
2725 ("sh", (RString "output", [String "command"]), 111, [],
2726 [], (* XXX needs tests *)
2727 "run a command via the shell",
2729 This call runs a command from the guest filesystem via the
2732 This is like C<guestfs_command>, but passes the command to:
2734 /bin/sh -c \"command\"
2736 Depending on the guest's shell, this usually results in
2737 wildcards being expanded, shell expressions being interpolated
2740 All the provisos about C<guestfs_command> apply to this call.");
2742 ("sh_lines", (RStringList "lines", [String "command"]), 112, [],
2743 [], (* XXX needs tests *)
2744 "run a command via the shell returning lines",
2746 This is the same as C<guestfs_sh>, but splits the result
2747 into a list of lines.
2749 See also: C<guestfs_command_lines>");
2751 ("glob_expand", (RStringList "paths", [Pathname "pattern"]), 113, [],
2752 (* Use Pathname here, and hence ABS_PATH (pattern,... in generated
2753 * code in stubs.c, since all valid glob patterns must start with "/".
2754 * There is no concept of "cwd" in libguestfs, hence no "."-relative names.
2756 [InitBasicFS, Always, TestOutputList (
2757 [["mkdir_p"; "/a/b/c"];
2758 ["touch"; "/a/b/c/d"];
2759 ["touch"; "/a/b/c/e"];
2760 ["glob_expand"; "/a/b/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2761 InitBasicFS, Always, TestOutputList (
2762 [["mkdir_p"; "/a/b/c"];
2763 ["touch"; "/a/b/c/d"];
2764 ["touch"; "/a/b/c/e"];
2765 ["glob_expand"; "/a/*/c/*"]], ["/a/b/c/d"; "/a/b/c/e"]);
2766 InitBasicFS, Always, TestOutputList (
2767 [["mkdir_p"; "/a/b/c"];
2768 ["touch"; "/a/b/c/d"];
2769 ["touch"; "/a/b/c/e"];
2770 ["glob_expand"; "/a/*/x/*"]], [])],
2771 "expand a wildcard path",
2773 This command searches for all the pathnames matching
2774 C<pattern> according to the wildcard expansion rules
2777 If no paths match, then this returns an empty list
2778 (note: not an error).
2780 It is just a wrapper around the C L<glob(3)> function
2781 with flags C<GLOB_MARK|GLOB_BRACE>.
2782 See that manual page for more details.");
2784 ("scrub_device", (RErr, [Device "device"]), 114, [DangerWillRobinson; Optional "scrub"],
2785 [InitNone, Always, TestRun ( (* use /dev/sdc because it's smaller *)
2786 [["scrub_device"; "/dev/sdc"]])],
2787 "scrub (securely wipe) a device",
2789 This command writes patterns over C<device> to make data retrieval
2792 It is an interface to the L<scrub(1)> program. See that
2793 manual page for more details.");
2795 ("scrub_file", (RErr, [Pathname "file"]), 115, [Optional "scrub"],
2796 [InitBasicFS, Always, TestRun (
2797 [["write"; "/file"; "content"];
2798 ["scrub_file"; "/file"]])],
2799 "scrub (securely wipe) a file",
2801 This command writes patterns over a file to make data retrieval
2804 The file is I<removed> after scrubbing.
2806 It is an interface to the L<scrub(1)> program. See that
2807 manual page for more details.");
2809 ("scrub_freespace", (RErr, [Pathname "dir"]), 116, [Optional "scrub"],
2810 [], (* XXX needs testing *)
2811 "scrub (securely wipe) free space",
2813 This command creates the directory C<dir> and then fills it
2814 with files until the filesystem is full, and scrubs the files
2815 as for C<guestfs_scrub_file>, and deletes them.
2816 The intention is to scrub any free space on the partition
2819 It is an interface to the L<scrub(1)> program. See that
2820 manual page for more details.");
2822 ("mkdtemp", (RString "dir", [Pathname "template"]), 117, [],
2823 [InitBasicFS, Always, TestRun (
2825 ["mkdtemp"; "/tmp/tmpXXXXXX"]])],
2826 "create a temporary directory",
2828 This command creates a temporary directory. The
2829 C<template> parameter should be a full pathname for the
2830 temporary directory name with the final six characters being
2833 For example: \"/tmp/myprogXXXXXX\" or \"/Temp/myprogXXXXXX\",
2834 the second one being suitable for Windows filesystems.
2836 The name of the temporary directory that was created
2839 The temporary directory is created with mode 0700
2840 and is owned by root.
2842 The caller is responsible for deleting the temporary
2843 directory and its contents after use.
2845 See also: L<mkdtemp(3)>");
2847 ("wc_l", (RInt "lines", [Pathname "path"]), 118, [],
2848 [InitISOFS, Always, TestOutputInt (
2849 [["wc_l"; "/10klines"]], 10000);
2850 (* Test for RHBZ#579608, absolute symbolic links. *)
2851 InitISOFS, Always, TestOutputInt (
2852 [["wc_l"; "/abssymlink"]], 10000)],
2853 "count lines in a file",
2855 This command counts the lines in a file, using the
2856 C<wc -l> external command.");
2858 ("wc_w", (RInt "words", [Pathname "path"]), 119, [],
2859 [InitISOFS, Always, TestOutputInt (
2860 [["wc_w"; "/10klines"]], 10000)],
2861 "count words in a file",
2863 This command counts the words in a file, using the
2864 C<wc -w> external command.");
2866 ("wc_c", (RInt "chars", [Pathname "path"]), 120, [],
2867 [InitISOFS, Always, TestOutputInt (
2868 [["wc_c"; "/100kallspaces"]], 102400)],
2869 "count characters in a file",
2871 This command counts the characters in a file, using the
2872 C<wc -c> external command.");
2874 ("head", (RStringList "lines", [Pathname "path"]), 121, [ProtocolLimitWarning],
2875 [InitISOFS, Always, TestOutputList (
2876 [["head"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"]);
2877 (* Test for RHBZ#579608, absolute symbolic links. *)
2878 InitISOFS, Always, TestOutputList (
2879 [["head"; "/abssymlink"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz";"3abcdefghijklmnopqrstuvwxyz";"4abcdefghijklmnopqrstuvwxyz";"5abcdefghijklmnopqrstuvwxyz";"6abcdefghijklmnopqrstuvwxyz";"7abcdefghijklmnopqrstuvwxyz";"8abcdefghijklmnopqrstuvwxyz";"9abcdefghijklmnopqrstuvwxyz"])],
2880 "return first 10 lines of a file",
2882 This command returns up to the first 10 lines of a file as
2883 a list of strings.");
2885 ("head_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 122, [ProtocolLimitWarning],
2886 [InitISOFS, Always, TestOutputList (
2887 [["head_n"; "3"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2888 InitISOFS, Always, TestOutputList (
2889 [["head_n"; "-9997"; "/10klines"]], ["0abcdefghijklmnopqrstuvwxyz";"1abcdefghijklmnopqrstuvwxyz";"2abcdefghijklmnopqrstuvwxyz"]);
2890 InitISOFS, Always, TestOutputList (
2891 [["head_n"; "0"; "/10klines"]], [])],
2892 "return first N lines of a file",
2894 If the parameter C<nrlines> is a positive number, this returns the first
2895 C<nrlines> lines of the file C<path>.
2897 If the parameter C<nrlines> is a negative number, this returns lines
2898 from the file C<path>, excluding the last C<nrlines> lines.
2900 If the parameter C<nrlines> is zero, this returns an empty list.");
2902 ("tail", (RStringList "lines", [Pathname "path"]), 123, [ProtocolLimitWarning],
2903 [InitISOFS, Always, TestOutputList (
2904 [["tail"; "/10klines"]], ["9990abcdefghijklmnopqrstuvwxyz";"9991abcdefghijklmnopqrstuvwxyz";"9992abcdefghijklmnopqrstuvwxyz";"9993abcdefghijklmnopqrstuvwxyz";"9994abcdefghijklmnopqrstuvwxyz";"9995abcdefghijklmnopqrstuvwxyz";"9996abcdefghijklmnopqrstuvwxyz";"9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"])],
2905 "return last 10 lines of a file",
2907 This command returns up to the last 10 lines of a file as
2908 a list of strings.");
2910 ("tail_n", (RStringList "lines", [Int "nrlines"; Pathname "path"]), 124, [ProtocolLimitWarning],
2911 [InitISOFS, Always, TestOutputList (
2912 [["tail_n"; "3"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2913 InitISOFS, Always, TestOutputList (
2914 [["tail_n"; "-9998"; "/10klines"]], ["9997abcdefghijklmnopqrstuvwxyz";"9998abcdefghijklmnopqrstuvwxyz";"9999abcdefghijklmnopqrstuvwxyz"]);
2915 InitISOFS, Always, TestOutputList (
2916 [["tail_n"; "0"; "/10klines"]], [])],
2917 "return last N lines of a file",
2919 If the parameter C<nrlines> is a positive number, this returns the last
2920 C<nrlines> lines of the file C<path>.
2922 If the parameter C<nrlines> is a negative number, this returns lines
2923 from the file C<path>, starting with the C<-nrlines>th line.
2925 If the parameter C<nrlines> is zero, this returns an empty list.");
2927 ("df", (RString "output", []), 125, [],
2928 [], (* XXX Tricky to test because it depends on the exact format
2929 * of the 'df' command and other imponderables.
2931 "report file system disk space usage",
2933 This command runs the C<df> command to report disk space used.
2935 This command is mostly useful for interactive sessions. It
2936 is I<not> intended that you try to parse the output string.
2937 Use C<statvfs> from programs.");
2939 ("df_h", (RString "output", []), 126, [],
2940 [], (* XXX Tricky to test because it depends on the exact format
2941 * of the 'df' command and other imponderables.
2943 "report file system disk space usage (human readable)",
2945 This command runs the C<df -h> command to report disk space used
2946 in human-readable format.
2948 This command is mostly useful for interactive sessions. It
2949 is I<not> intended that you try to parse the output string.
2950 Use C<statvfs> from programs.");
2952 ("du", (RInt64 "sizekb", [Pathname "path"]), 127, [],
2953 [InitISOFS, Always, TestOutputInt (
2954 [["du"; "/directory"]], 2 (* ISO fs blocksize is 2K *))],
2955 "estimate file space usage",
2957 This command runs the C<du -s> command to estimate file space
2960 C<path> can be a file or a directory. If C<path> is a directory
2961 then the estimate includes the contents of the directory and all
2962 subdirectories (recursively).
2964 The result is the estimated size in I<kilobytes>
2965 (ie. units of 1024 bytes).");
2967 ("initrd_list", (RStringList "filenames", [Pathname "path"]), 128, [],
2968 [InitISOFS, Always, TestOutputList (
2969 [["initrd_list"; "/initrd"]], ["empty";"known-1";"known-2";"known-3";"known-4"; "known-5"])],
2970 "list files in an initrd",
2972 This command lists out files contained in an initrd.
2974 The files are listed without any initial C</> character. The
2975 files are listed in the order they appear (not necessarily
2976 alphabetical). Directory names are listed as separate items.
2978 Old Linux kernels (2.4 and earlier) used a compressed ext2
2979 filesystem as initrd. We I<only> support the newer initramfs
2980 format (compressed cpio files).");
2982 ("mount_loop", (RErr, [Pathname "file"; Pathname "mountpoint"]), 129, [],
2984 "mount a file using the loop device",
2986 This command lets you mount C<file> (a filesystem image
2987 in a file) on a mount point. It is entirely equivalent to
2988 the command C<mount -o loop file mountpoint>.");
2990 ("mkswap", (RErr, [Device "device"]), 130, [],
2991 [InitEmpty, Always, TestRun (
2992 [["part_disk"; "/dev/sda"; "mbr"];
2993 ["mkswap"; "/dev/sda1"]])],
2994 "create a swap partition",
2996 Create a swap partition on C<device>.");
2998 ("mkswap_L", (RErr, [String "label"; Device "device"]), 131, [],
2999 [InitEmpty, Always, TestRun (
3000 [["part_disk"; "/dev/sda"; "mbr"];
3001 ["mkswap_L"; "hello"; "/dev/sda1"]])],
3002 "create a swap partition with a label",
3004 Create a swap partition on C<device> with label C<label>.
3006 Note that you cannot attach a swap label to a block device
3007 (eg. C</dev/sda>), just to a partition. This appears to be
3008 a limitation of the kernel or swap tools.");
3010 ("mkswap_U", (RErr, [String "uuid"; Device "device"]), 132, [Optional "linuxfsuuid"],
3011 (let uuid = uuidgen () in
3012 [InitEmpty, Always, TestRun (
3013 [["part_disk"; "/dev/sda"; "mbr"];
3014 ["mkswap_U"; uuid; "/dev/sda1"]])]),
3015 "create a swap partition with an explicit UUID",
3017 Create a swap partition on C<device> with UUID C<uuid>.");
3019 ("mknod", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 133, [Optional "mknod"],
3020 [InitBasicFS, Always, TestOutputStruct (
3021 [["mknod"; "0o10777"; "0"; "0"; "/node"];
3022 (* NB: default umask 022 means 0777 -> 0755 in these tests *)
3023 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)]);
3024 InitBasicFS, Always, TestOutputStruct (
3025 [["mknod"; "0o60777"; "66"; "99"; "/node"];
3026 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3027 "make block, character or FIFO devices",
3029 This call creates block or character special devices, or
3030 named pipes (FIFOs).
3032 The C<mode> parameter should be the mode, using the standard
3033 constants. C<devmajor> and C<devminor> are the
3034 device major and minor numbers, only used when creating block
3035 and character special devices.
3037 Note that, just like L<mknod(2)>, the mode must be bitwise
3038 OR'd with S_IFBLK, S_IFCHR, S_IFIFO or S_IFSOCK (otherwise this call
3039 just creates a regular file). These constants are
3040 available in the standard Linux header files, or you can use
3041 C<guestfs_mknod_b>, C<guestfs_mknod_c> or C<guestfs_mkfifo>
3042 which are wrappers around this command which bitwise OR
3043 in the appropriate constant for you.
3045 The mode actually set is affected by the umask.");
3047 ("mkfifo", (RErr, [Int "mode"; Pathname "path"]), 134, [Optional "mknod"],
3048 [InitBasicFS, Always, TestOutputStruct (
3049 [["mkfifo"; "0o777"; "/node"];
3050 ["stat"; "/node"]], [CompareWithInt ("mode", 0o10755)])],
3051 "make FIFO (named pipe)",
3053 This call creates a FIFO (named pipe) called C<path> with
3054 mode C<mode>. It is just a convenient wrapper around
3057 The mode actually set is affected by the umask.");
3059 ("mknod_b", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 135, [Optional "mknod"],
3060 [InitBasicFS, Always, TestOutputStruct (
3061 [["mknod_b"; "0o777"; "99"; "66"; "/node"];
3062 ["stat"; "/node"]], [CompareWithInt ("mode", 0o60755)])],
3063 "make block device node",
3065 This call creates a block device node called C<path> with
3066 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3067 It is just a convenient wrapper around C<guestfs_mknod>.
3069 The mode actually set is affected by the umask.");
3071 ("mknod_c", (RErr, [Int "mode"; Int "devmajor"; Int "devminor"; Pathname "path"]), 136, [Optional "mknod"],
3072 [InitBasicFS, Always, TestOutputStruct (
3073 [["mknod_c"; "0o777"; "99"; "66"; "/node"];
3074 ["stat"; "/node"]], [CompareWithInt ("mode", 0o20755)])],
3075 "make char device node",
3077 This call creates a char device node called C<path> with
3078 mode C<mode> and device major/minor C<devmajor> and C<devminor>.
3079 It is just a convenient wrapper around C<guestfs_mknod>.
3081 The mode actually set is affected by the umask.");
3083 ("umask", (RInt "oldmask", [Int "mask"]), 137, [FishOutput FishOutputOctal],
3084 [InitEmpty, Always, TestOutputInt (
3085 [["umask"; "0o22"]], 0o22)],
3086 "set file mode creation mask (umask)",
3088 This function sets the mask used for creating new files and
3089 device nodes to C<mask & 0777>.
3091 Typical umask values would be C<022> which creates new files
3092 with permissions like \"-rw-r--r--\" or \"-rwxr-xr-x\", and
3093 C<002> which creates new files with permissions like
3094 \"-rw-rw-r--\" or \"-rwxrwxr-x\".
3096 The default umask is C<022>. This is important because it
3097 means that directories and device nodes will be created with
3098 C<0644> or C<0755> mode even if you specify C<0777>.
3100 See also C<guestfs_get_umask>,
3101 L<umask(2)>, C<guestfs_mknod>, C<guestfs_mkdir>.
3103 This call returns the previous umask.");
3105 ("readdir", (RStructList ("entries", "dirent"), [Pathname "dir"]), 138, [],
3107 "read directories entries",
3109 This returns the list of directory entries in directory C<dir>.
3111 All entries in the directory are returned, including C<.> and
3112 C<..>. The entries are I<not> sorted, but returned in the same
3113 order as the underlying filesystem.
3115 Also this call returns basic file type information about each
3116 file. The C<ftyp> field will contain one of the following characters:
3154 The L<readdir(3)> returned a C<d_type> field with an
3159 This function is primarily intended for use by programs. To
3160 get a simple list of names, use C<guestfs_ls>. To get a printable
3161 directory for human consumption, use C<guestfs_ll>.");
3163 ("sfdiskM", (RErr, [Device "device"; StringList "lines"]), 139, [DangerWillRobinson],
3165 "create partitions on a block device",
3167 This is a simplified interface to the C<guestfs_sfdisk>
3168 command, where partition sizes are specified in megabytes
3169 only (rounded to the nearest cylinder) and you don't need
3170 to specify the cyls, heads and sectors parameters which
3171 were rarely if ever used anyway.
3173 See also: C<guestfs_sfdisk>, the L<sfdisk(8)> manpage
3174 and C<guestfs_part_disk>");
3176 ("zfile", (RString "description", [String "meth"; Pathname "path"]), 140, [DeprecatedBy "file"],
3178 "determine file type inside a compressed file",
3180 This command runs C<file> after first decompressing C<path>
3183 C<method> must be one of C<gzip>, C<compress> or C<bzip2>.
3185 Since 1.0.63, use C<guestfs_file> instead which can now
3186 process compressed files.");
3188 ("getxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 141, [Optional "linuxxattrs"],
3190 "list extended attributes of a file or directory",
3192 This call lists the extended attributes of the file or directory
3195 At the system call level, this is a combination of the
3196 L<listxattr(2)> and L<getxattr(2)> calls.
3198 See also: C<guestfs_lgetxattrs>, L<attr(5)>.");
3200 ("lgetxattrs", (RStructList ("xattrs", "xattr"), [Pathname "path"]), 142, [Optional "linuxxattrs"],
3202 "list extended attributes of a file or directory",
3204 This is the same as C<guestfs_getxattrs>, but if C<path>
3205 is a symbolic link, then it returns the extended attributes
3206 of the link itself.");
3208 ("setxattr", (RErr, [String "xattr";
3209 String "val"; Int "vallen"; (* will be BufferIn *)
3210 Pathname "path"]), 143, [Optional "linuxxattrs"],
3212 "set extended attribute of a file or directory",
3214 This call sets the extended attribute named C<xattr>
3215 of the file C<path> to the value C<val> (of length C<vallen>).
3216 The value is arbitrary 8 bit data.
3218 See also: C<guestfs_lsetxattr>, L<attr(5)>.");
3220 ("lsetxattr", (RErr, [String "xattr";
3221 String "val"; Int "vallen"; (* will be BufferIn *)
3222 Pathname "path"]), 144, [Optional "linuxxattrs"],
3224 "set extended attribute of a file or directory",
3226 This is the same as C<guestfs_setxattr>, but if C<path>
3227 is a symbolic link, then it sets an extended attribute
3228 of the link itself.");
3230 ("removexattr", (RErr, [String "xattr"; Pathname "path"]), 145, [Optional "linuxxattrs"],
3232 "remove extended attribute of a file or directory",
3234 This call removes the extended attribute named C<xattr>
3235 of the file C<path>.
3237 See also: C<guestfs_lremovexattr>, L<attr(5)>.");
3239 ("lremovexattr", (RErr, [String "xattr"; Pathname "path"]), 146, [Optional "linuxxattrs"],
3241 "remove extended attribute of a file or directory",
3243 This is the same as C<guestfs_removexattr>, but if C<path>
3244 is a symbolic link, then it removes an extended attribute
3245 of the link itself.");
3247 ("mountpoints", (RHashtable "mps", []), 147, [],
3251 This call is similar to C<guestfs_mounts>. That call returns
3252 a list of devices. This one returns a hash table (map) of
3253 device name to directory where the device is mounted.");
3255 ("mkmountpoint", (RErr, [String "exemptpath"]), 148, [],
3256 (* This is a special case: while you would expect a parameter
3257 * of type "Pathname", that doesn't work, because it implies
3258 * NEED_ROOT in the generated calling code in stubs.c, and
3259 * this function cannot use NEED_ROOT.
3262 "create a mountpoint",
3264 C<guestfs_mkmountpoint> and C<guestfs_rmmountpoint> are
3265 specialized calls that can be used to create extra mountpoints
3266 before mounting the first filesystem.
3268 These calls are I<only> necessary in some very limited circumstances,
3269 mainly the case where you want to mount a mix of unrelated and/or
3270 read-only filesystems together.
3272 For example, live CDs often contain a \"Russian doll\" nest of
3273 filesystems, an ISO outer layer, with a squashfs image inside, with
3274 an ext2/3 image inside that. You can unpack this as follows
3277 add-ro Fedora-11-i686-Live.iso
3280 mkmountpoint /squash
3283 mount-loop /cd/LiveOS/squashfs.img /squash
3284 mount-loop /squash/LiveOS/ext3fs.img /ext3
3286 The inner filesystem is now unpacked under the /ext3 mountpoint.");
3288 ("rmmountpoint", (RErr, [String "exemptpath"]), 149, [],
3290 "remove a mountpoint",
3292 This calls removes a mountpoint that was previously created
3293 with C<guestfs_mkmountpoint>. See C<guestfs_mkmountpoint>
3294 for full details.");
3296 ("read_file", (RBufferOut "content", [Pathname "path"]), 150, [ProtocolLimitWarning],
3297 [InitISOFS, Always, TestOutputBuffer (
3298 [["read_file"; "/known-4"]], "abc\ndef\nghi");
3299 (* Test various near large, large and too large files (RHBZ#589039). *)
3300 InitBasicFS, Always, TestLastFail (
3302 ["truncate_size"; "/a"; "4194303"]; (* GUESTFS_MESSAGE_MAX - 1 *)
3303 ["read_file"; "/a"]]);
3304 InitBasicFS, Always, TestLastFail (
3306 ["truncate_size"; "/a"; "4194304"]; (* GUESTFS_MESSAGE_MAX *)
3307 ["read_file"; "/a"]]);
3308 InitBasicFS, Always, TestLastFail (
3310 ["truncate_size"; "/a"; "41943040"]; (* GUESTFS_MESSAGE_MAX * 10 *)
3311 ["read_file"; "/a"]])],
3314 This calls returns the contents of the file C<path> as a
3317 Unlike C<guestfs_cat>, this function can correctly
3318 handle files that contain embedded ASCII NUL characters.
3319 However unlike C<guestfs_download>, this function is limited
3320 in the total size of file that can be handled.");
3322 ("grep", (RStringList "lines", [String "regex"; Pathname "path"]), 151, [ProtocolLimitWarning],
3323 [InitISOFS, Always, TestOutputList (
3324 [["grep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"]);
3325 InitISOFS, Always, TestOutputList (
3326 [["grep"; "nomatch"; "/test-grep.txt"]], []);
3327 (* Test for RHBZ#579608, absolute symbolic links. *)
3328 InitISOFS, Always, TestOutputList (
3329 [["grep"; "nomatch"; "/abssymlink"]], [])],
3330 "return lines matching a pattern",
3332 This calls the external C<grep> program and returns the
3335 ("egrep", (RStringList "lines", [String "regex"; Pathname "path"]), 152, [ProtocolLimitWarning],
3336 [InitISOFS, Always, TestOutputList (
3337 [["egrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3338 "return lines matching a pattern",
3340 This calls the external C<egrep> program and returns the
3343 ("fgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 153, [ProtocolLimitWarning],
3344 [InitISOFS, Always, TestOutputList (
3345 [["fgrep"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"])],
3346 "return lines matching a pattern",
3348 This calls the external C<fgrep> program and returns the
3351 ("grepi", (RStringList "lines", [String "regex"; Pathname "path"]), 154, [ProtocolLimitWarning],
3352 [InitISOFS, Always, TestOutputList (
3353 [["grepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3354 "return lines matching a pattern",
3356 This calls the external C<grep -i> program and returns the
3359 ("egrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 155, [ProtocolLimitWarning],
3360 [InitISOFS, Always, TestOutputList (
3361 [["egrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3362 "return lines matching a pattern",
3364 This calls the external C<egrep -i> program and returns the
3367 ("fgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 156, [ProtocolLimitWarning],
3368 [InitISOFS, Always, TestOutputList (
3369 [["fgrepi"; "abc"; "/test-grep.txt"]], ["abc"; "abc123"; "ABC"])],
3370 "return lines matching a pattern",
3372 This calls the external C<fgrep -i> program and returns the
3375 ("zgrep", (RStringList "lines", [String "regex"; Pathname "path"]), 157, [ProtocolLimitWarning],
3376 [InitISOFS, Always, TestOutputList (
3377 [["zgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3378 "return lines matching a pattern",
3380 This calls the external C<zgrep> program and returns the
3383 ("zegrep", (RStringList "lines", [String "regex"; Pathname "path"]), 158, [ProtocolLimitWarning],
3384 [InitISOFS, Always, TestOutputList (
3385 [["zegrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3386 "return lines matching a pattern",
3388 This calls the external C<zegrep> program and returns the
3391 ("zfgrep", (RStringList "lines", [String "pattern"; Pathname "path"]), 159, [ProtocolLimitWarning],
3392 [InitISOFS, Always, TestOutputList (
3393 [["zfgrep"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"])],
3394 "return lines matching a pattern",
3396 This calls the external C<zfgrep> program and returns the
3399 ("zgrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 160, [ProtocolLimitWarning],
3400 [InitISOFS, Always, TestOutputList (
3401 [["zgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3402 "return lines matching a pattern",
3404 This calls the external C<zgrep -i> program and returns the
3407 ("zegrepi", (RStringList "lines", [String "regex"; Pathname "path"]), 161, [ProtocolLimitWarning],
3408 [InitISOFS, Always, TestOutputList (
3409 [["zegrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3410 "return lines matching a pattern",
3412 This calls the external C<zegrep -i> program and returns the
3415 ("zfgrepi", (RStringList "lines", [String "pattern"; Pathname "path"]), 162, [ProtocolLimitWarning],
3416 [InitISOFS, Always, TestOutputList (
3417 [["zfgrepi"; "abc"; "/test-grep.txt.gz"]], ["abc"; "abc123"; "ABC"])],
3418 "return lines matching a pattern",
3420 This calls the external C<zfgrep -i> program and returns the
3423 ("realpath", (RString "rpath", [Pathname "path"]), 163, [Optional "realpath"],
3424 [InitISOFS, Always, TestOutput (
3425 [["realpath"; "/../directory"]], "/directory")],
3426 "canonicalized absolute pathname",
3428 Return the canonicalized absolute pathname of C<path>. The
3429 returned path has no C<.>, C<..> or symbolic link path elements.");
3431 ("ln", (RErr, [String "target"; Pathname "linkname"]), 164, [],
3432 [InitBasicFS, Always, TestOutputStruct (
3435 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3436 "create a hard link",
3438 This command creates a hard link using the C<ln> command.");
3440 ("ln_f", (RErr, [String "target"; Pathname "linkname"]), 165, [],
3441 [InitBasicFS, Always, TestOutputStruct (
3444 ["ln_f"; "/a"; "/b"];
3445 ["stat"; "/b"]], [CompareWithInt ("nlink", 2)])],
3446 "create a hard link",
3448 This command creates a hard link using the C<ln -f> command.
3449 The C<-f> option removes the link (C<linkname>) if it exists already.");
3451 ("ln_s", (RErr, [String "target"; Pathname "linkname"]), 166, [],
3452 [InitBasicFS, Always, TestOutputStruct (
3454 ["ln_s"; "a"; "/b"];
3455 ["lstat"; "/b"]], [CompareWithInt ("mode", 0o120777)])],
3456 "create a symbolic link",
3458 This command creates a symbolic link using the C<ln -s> command.");
3460 ("ln_sf", (RErr, [String "target"; Pathname "linkname"]), 167, [],
3461 [InitBasicFS, Always, TestOutput (
3462 [["mkdir_p"; "/a/b"];
3463 ["touch"; "/a/b/c"];
3464 ["ln_sf"; "../d"; "/a/b/c"];
3465 ["readlink"; "/a/b/c"]], "../d")],
3466 "create a symbolic link",
3468 This command creates a symbolic link using the C<ln -sf> command,
3469 The C<-f> option removes the link (C<linkname>) if it exists already.");
3471 ("readlink", (RString "link", [Pathname "path"]), 168, [],
3472 [] (* XXX tested above *),
3473 "read the target of a symbolic link",
3475 This command reads the target of a symbolic link.");
3477 ("fallocate", (RErr, [Pathname "path"; Int "len"]), 169, [],
3478 [InitBasicFS, Always, TestOutputStruct (
3479 [["fallocate"; "/a"; "1000000"];
3480 ["stat"; "/a"]], [CompareWithInt ("size", 1_000_000)])],
3481 "preallocate a file in the guest filesystem",
3483 This command preallocates a file (containing zero bytes) named
3484 C<path> of size C<len> bytes. If the file exists already, it
3487 Do not confuse this with the guestfish-specific
3488 C<alloc> command which allocates a file in the host and
3489 attaches it as a device.");
3491 ("swapon_device", (RErr, [Device "device"]), 170, [],
3492 [InitPartition, Always, TestRun (
3493 [["mkswap"; "/dev/sda1"];
3494 ["swapon_device"; "/dev/sda1"];
3495 ["swapoff_device"; "/dev/sda1"]])],
3496 "enable swap on device",
3498 This command enables the libguestfs appliance to use the
3499 swap device or partition named C<device>. The increased
3500 memory is made available for all commands, for example
3501 those run using C<guestfs_command> or C<guestfs_sh>.
3503 Note that you should not swap to existing guest swap
3504 partitions unless you know what you are doing. They may
3505 contain hibernation information, or other information that
3506 the guest doesn't want you to trash. You also risk leaking
3507 information about the host to the guest this way. Instead,
3508 attach a new host device to the guest and swap on that.");
3510 ("swapoff_device", (RErr, [Device "device"]), 171, [],
3511 [], (* XXX tested by swapon_device *)
3512 "disable swap on device",
3514 This command disables the libguestfs appliance swap
3515 device or partition named C<device>.
3516 See C<guestfs_swapon_device>.");
3518 ("swapon_file", (RErr, [Pathname "file"]), 172, [],
3519 [InitBasicFS, Always, TestRun (
3520 [["fallocate"; "/swap"; "8388608"];
3521 ["mkswap_file"; "/swap"];
3522 ["swapon_file"; "/swap"];
3523 ["swapoff_file"; "/swap"]])],
3524 "enable swap on file",
3526 This command enables swap to a file.
3527 See C<guestfs_swapon_device> for other notes.");
3529 ("swapoff_file", (RErr, [Pathname "file"]), 173, [],
3530 [], (* XXX tested by swapon_file *)
3531 "disable swap on file",
3533 This command disables the libguestfs appliance swap on file.");
3535 ("swapon_label", (RErr, [String "label"]), 174, [],
3536 [InitEmpty, Always, TestRun (
3537 [["part_disk"; "/dev/sdb"; "mbr"];
3538 ["mkswap_L"; "swapit"; "/dev/sdb1"];
3539 ["swapon_label"; "swapit"];
3540 ["swapoff_label"; "swapit"];
3541 ["zero"; "/dev/sdb"];
3542 ["blockdev_rereadpt"; "/dev/sdb"]])],
3543 "enable swap on labeled swap partition",
3545 This command enables swap to a labeled swap partition.
3546 See C<guestfs_swapon_device> for other notes.");
3548 ("swapoff_label", (RErr, [String "label"]), 175, [],
3549 [], (* XXX tested by swapon_label *)
3550 "disable swap on labeled swap partition",
3552 This command disables the libguestfs appliance swap on
3553 labeled swap partition.");
3555 ("swapon_uuid", (RErr, [String "uuid"]), 176, [Optional "linuxfsuuid"],
3556 (let uuid = uuidgen () in
3557 [InitEmpty, Always, TestRun (
3558 [["mkswap_U"; uuid; "/dev/sdb"];
3559 ["swapon_uuid"; uuid];
3560 ["swapoff_uuid"; uuid]])]),
3561 "enable swap on swap partition by UUID",
3563 This command enables swap to a swap partition with the given UUID.
3564 See C<guestfs_swapon_device> for other notes.");
3566 ("swapoff_uuid", (RErr, [String "uuid"]), 177, [Optional "linuxfsuuid"],
3567 [], (* XXX tested by swapon_uuid *)
3568 "disable swap on swap partition by UUID",
3570 This command disables the libguestfs appliance swap partition
3571 with the given UUID.");
3573 ("mkswap_file", (RErr, [Pathname "path"]), 178, [],
3574 [InitBasicFS, Always, TestRun (
3575 [["fallocate"; "/swap"; "8388608"];
3576 ["mkswap_file"; "/swap"]])],
3577 "create a swap file",
3581 This command just writes a swap file signature to an existing
3582 file. To create the file itself, use something like C<guestfs_fallocate>.");
3584 ("inotify_init", (RErr, [Int "maxevents"]), 179, [Optional "inotify"],
3585 [InitISOFS, Always, TestRun (
3586 [["inotify_init"; "0"]])],
3587 "create an inotify handle",
3589 This command creates a new inotify handle.
3590 The inotify subsystem can be used to notify events which happen to
3591 objects in the guest filesystem.
3593 C<maxevents> is the maximum number of events which will be
3594 queued up between calls to C<guestfs_inotify_read> or
3595 C<guestfs_inotify_files>.
3596 If this is passed as C<0>, then the kernel (or previously set)
3597 default is used. For Linux 2.6.29 the default was 16384 events.
3598 Beyond this limit, the kernel throws away events, but records
3599 the fact that it threw them away by setting a flag
3600 C<IN_Q_OVERFLOW> in the returned structure list (see
3601 C<guestfs_inotify_read>).
3603 Before any events are generated, you have to add some
3604 watches to the internal watch list. See:
3605 C<guestfs_inotify_add_watch>,
3606 C<guestfs_inotify_rm_watch> and
3607 C<guestfs_inotify_watch_all>.
3609 Queued up events should be read periodically by calling
3610 C<guestfs_inotify_read>
3611 (or C<guestfs_inotify_files> which is just a helpful
3612 wrapper around C<guestfs_inotify_read>). If you don't
3613 read the events out often enough then you risk the internal
3616 The handle should be closed after use by calling
3617 C<guestfs_inotify_close>. This also removes any
3618 watches automatically.
3620 See also L<inotify(7)> for an overview of the inotify interface
3621 as exposed by the Linux kernel, which is roughly what we expose
3622 via libguestfs. Note that there is one global inotify handle
3623 per libguestfs instance.");
3625 ("inotify_add_watch", (RInt64 "wd", [Pathname "path"; Int "mask"]), 180, [Optional "inotify"],
3626 [InitBasicFS, Always, TestOutputList (
3627 [["inotify_init"; "0"];
3628 ["inotify_add_watch"; "/"; "1073741823"];
3631 ["inotify_files"]], ["a"; "b"])],
3632 "add an inotify watch",
3634 Watch C<path> for the events listed in C<mask>.
3636 Note that if C<path> is a directory then events within that
3637 directory are watched, but this does I<not> happen recursively
3638 (in subdirectories).
3640 Note for non-C or non-Linux callers: the inotify events are
3641 defined by the Linux kernel ABI and are listed in
3642 C</usr/include/sys/inotify.h>.");
3644 ("inotify_rm_watch", (RErr, [Int(*XXX64*) "wd"]), 181, [Optional "inotify"],
3646 "remove an inotify watch",
3648 Remove a previously defined inotify watch.
3649 See C<guestfs_inotify_add_watch>.");
3651 ("inotify_read", (RStructList ("events", "inotify_event"), []), 182, [Optional "inotify"],
3653 "return list of inotify events",
3655 Return the complete queue of events that have happened
3656 since the previous read call.
3658 If no events have happened, this returns an empty list.
3660 I<Note>: In order to make sure that all events have been
3661 read, you must call this function repeatedly until it
3662 returns an empty list. The reason is that the call will
3663 read events up to the maximum appliance-to-host message
3664 size and leave remaining events in the queue.");
3666 ("inotify_files", (RStringList "paths", []), 183, [Optional "inotify"],
3668 "return list of watched files that had events",
3670 This function is a helpful wrapper around C<guestfs_inotify_read>
3671 which just returns a list of pathnames of objects that were
3672 touched. The returned pathnames are sorted and deduplicated.");
3674 ("inotify_close", (RErr, []), 184, [Optional "inotify"],
3676 "close the inotify handle",
3678 This closes the inotify handle which was previously
3679 opened by inotify_init. It removes all watches, throws
3680 away any pending events, and deallocates all resources.");
3682 ("setcon", (RErr, [String "context"]), 185, [Optional "selinux"],
3684 "set SELinux security context",
3686 This sets the SELinux security context of the daemon
3687 to the string C<context>.
3689 See the documentation about SELINUX in L<guestfs(3)>.");
3691 ("getcon", (RString "context", []), 186, [Optional "selinux"],
3693 "get SELinux security context",
3695 This gets the SELinux security context of the daemon.
3697 See the documentation about SELINUX in L<guestfs(3)>,
3698 and C<guestfs_setcon>");
3700 ("mkfs_b", (RErr, [String "fstype"; Int "blocksize"; Device "device"]), 187, [],
3701 [InitEmpty, Always, TestOutput (
3702 [["part_disk"; "/dev/sda"; "mbr"];
3703 ["mkfs_b"; "ext2"; "4096"; "/dev/sda1"];
3704 ["mount_options"; ""; "/dev/sda1"; "/"];
3705 ["write"; "/new"; "new file contents"];
3706 ["cat"; "/new"]], "new file contents")],
3707 "make a filesystem with block size",
3709 This call is similar to C<guestfs_mkfs>, but it allows you to
3710 control the block size of the resulting filesystem. Supported
3711 block sizes depend on the filesystem type, but typically they
3712 are C<1024>, C<2048> or C<4096> only.");
3714 ("mke2journal", (RErr, [Int "blocksize"; Device "device"]), 188, [],
3715 [InitEmpty, Always, TestOutput (
3716 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3717 ["mke2journal"; "4096"; "/dev/sda1"];
3718 ["mke2fs_J"; "ext2"; "4096"; "/dev/sda2"; "/dev/sda1"];
3719 ["mount_options"; ""; "/dev/sda2"; "/"];
3720 ["write"; "/new"; "new file contents"];
3721 ["cat"; "/new"]], "new file contents")],
3722 "make ext2/3/4 external journal",
3724 This creates an ext2 external journal on C<device>. It is equivalent
3727 mke2fs -O journal_dev -b blocksize device");
3729 ("mke2journal_L", (RErr, [Int "blocksize"; String "label"; Device "device"]), 189, [],
3730 [InitEmpty, Always, TestOutput (
3731 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3732 ["mke2journal_L"; "4096"; "JOURNAL"; "/dev/sda1"];
3733 ["mke2fs_JL"; "ext2"; "4096"; "/dev/sda2"; "JOURNAL"];
3734 ["mount_options"; ""; "/dev/sda2"; "/"];
3735 ["write"; "/new"; "new file contents"];
3736 ["cat"; "/new"]], "new file contents")],
3737 "make ext2/3/4 external journal with label",
3739 This creates an ext2 external journal on C<device> with label C<label>.");
3741 ("mke2journal_U", (RErr, [Int "blocksize"; String "uuid"; Device "device"]), 190, [Optional "linuxfsuuid"],
3742 (let uuid = uuidgen () in
3743 [InitEmpty, Always, TestOutput (
3744 [["sfdiskM"; "/dev/sda"; ",100 ,"];
3745 ["mke2journal_U"; "4096"; uuid; "/dev/sda1"];
3746 ["mke2fs_JU"; "ext2"; "4096"; "/dev/sda2"; uuid];
3747 ["mount_options"; ""; "/dev/sda2"; "/"];
3748 ["write"; "/new"; "new file contents"];
3749 ["cat"; "/new"]], "new file contents")]),
3750 "make ext2/3/4 external journal with UUID",
3752 This creates an ext2 external journal on C<device> with UUID C<uuid>.");
3754 ("mke2fs_J", (RErr, [String "fstype"; Int "blocksize"; Device "device"; Device "journal"]), 191, [],
3756 "make ext2/3/4 filesystem with external journal",
3758 This creates an ext2/3/4 filesystem on C<device> with
3759 an external journal on C<journal>. It is equivalent
3762 mke2fs -t fstype -b blocksize -J device=<journal> <device>
3764 See also C<guestfs_mke2journal>.");
3766 ("mke2fs_JL", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "label"]), 192, [],
3768 "make ext2/3/4 filesystem with external journal",
3770 This creates an ext2/3/4 filesystem on C<device> with
3771 an external journal on the journal labeled C<label>.
3773 See also C<guestfs_mke2journal_L>.");
3775 ("mke2fs_JU", (RErr, [String "fstype"; Int "blocksize"; Device "device"; String "uuid"]), 193, [Optional "linuxfsuuid"],
3777 "make ext2/3/4 filesystem with external journal",
3779 This creates an ext2/3/4 filesystem on C<device> with
3780 an external journal on the journal with UUID C<uuid>.
3782 See also C<guestfs_mke2journal_U>.");
3784 ("modprobe", (RErr, [String "modulename"]), 194, [Optional "linuxmodules"],
3785 [InitNone, Always, TestRun [["modprobe"; "fat"]]],
3786 "load a kernel module",
3788 This loads a kernel module in the appliance.
3790 The kernel module must have been whitelisted when libguestfs
3791 was built (see C<appliance/kmod.whitelist.in> in the source).");
3793 ("echo_daemon", (RString "output", [StringList "words"]), 195, [],
3794 [InitNone, Always, TestOutput (
3795 [["echo_daemon"; "This is a test"]], "This is a test"
3797 "echo arguments back to the client",
3799 This command concatenate the list of C<words> passed with single spaces between
3800 them and returns the resulting string.
3802 You can use this command to test the connection through to the daemon.
3804 See also C<guestfs_ping_daemon>.");
3806 ("find0", (RErr, [Pathname "directory"; FileOut "files"]), 196, [],
3807 [], (* There is a regression test for this. *)
3808 "find all files and directories, returning NUL-separated list",
3810 This command lists out all files and directories, recursively,
3811 starting at C<directory>, placing the resulting list in the
3812 external file called C<files>.
3814 This command works the same way as C<guestfs_find> with the
3815 following exceptions:
3821 The resulting list is written to an external file.
3825 Items (filenames) in the result are separated
3826 by C<\\0> characters. See L<find(1)> option I<-print0>.
3830 This command is not limited in the number of names that it
3835 The result list is not sorted.
3839 ("case_sensitive_path", (RString "rpath", [Pathname "path"]), 197, [],
3840 [InitISOFS, Always, TestOutput (
3841 [["case_sensitive_path"; "/DIRECTORY"]], "/directory");
3842 InitISOFS, Always, TestOutput (
3843 [["case_sensitive_path"; "/DIRECTORY/"]], "/directory");
3844 InitISOFS, Always, TestOutput (
3845 [["case_sensitive_path"; "/Known-1"]], "/known-1");
3846 InitISOFS, Always, TestLastFail (
3847 [["case_sensitive_path"; "/Known-1/"]]);
3848 InitBasicFS, Always, TestOutput (
3850 ["mkdir"; "/a/bbb"];
3851 ["touch"; "/a/bbb/c"];
3852 ["case_sensitive_path"; "/A/bbB/C"]], "/a/bbb/c");
3853 InitBasicFS, Always, TestOutput (
3855 ["mkdir"; "/a/bbb"];
3856 ["touch"; "/a/bbb/c"];
3857 ["case_sensitive_path"; "/A////bbB/C"]], "/a/bbb/c");
3858 InitBasicFS, Always, TestLastFail (
3860 ["mkdir"; "/a/bbb"];
3861 ["touch"; "/a/bbb/c"];
3862 ["case_sensitive_path"; "/A/bbb/../bbb/C"]])],
3863 "return true path on case-insensitive filesystem",
3865 This can be used to resolve case insensitive paths on
3866 a filesystem which is case sensitive. The use case is
3867 to resolve paths which you have read from Windows configuration
3868 files or the Windows Registry, to the true path.
3870 The command handles a peculiarity of the Linux ntfs-3g
3871 filesystem driver (and probably others), which is that although
3872 the underlying filesystem is case-insensitive, the driver
3873 exports the filesystem to Linux as case-sensitive.
3875 One consequence of this is that special directories such
3876 as C<c:\\windows> may appear as C</WINDOWS> or C</windows>
3877 (or other things) depending on the precise details of how
3878 they were created. In Windows itself this would not be
3881 Bug or feature? You decide:
3882 L<http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1>
3884 This function resolves the true case of each element in the
3885 path and returns the case-sensitive path.
3887 Thus C<guestfs_case_sensitive_path> (\"/Windows/System32\")
3888 might return C<\"/WINDOWS/system32\"> (the exact return value
3889 would depend on details of how the directories were originally
3890 created under Windows).
3893 This function does not handle drive names, backslashes etc.
3895 See also C<guestfs_realpath>.");
3897 ("vfs_type", (RString "fstype", [Device "device"]), 198, [],
3898 [InitBasicFS, Always, TestOutput (
3899 [["vfs_type"; "/dev/sda1"]], "ext2")],
3900 "get the Linux VFS type corresponding to a mounted device",
3902 This command gets the block device type corresponding to
3903 a mounted device called C<device>.
3905 Usually the result is the name of the Linux VFS module that
3906 is used to mount this device (probably determined automatically
3907 if you used the C<guestfs_mount> call).");
3909 ("truncate", (RErr, [Pathname "path"]), 199, [],
3910 [InitBasicFS, Always, TestOutputStruct (
3911 [["write"; "/test"; "some stuff so size is not zero"];
3912 ["truncate"; "/test"];
3913 ["stat"; "/test"]], [CompareWithInt ("size", 0)])],
3914 "truncate a file to zero size",
3916 This command truncates C<path> to a zero-length file. The
3917 file must exist already.");
3919 ("truncate_size", (RErr, [Pathname "path"; Int64 "size"]), 200, [],
3920 [InitBasicFS, Always, TestOutputStruct (
3921 [["touch"; "/test"];
3922 ["truncate_size"; "/test"; "1000"];
3923 ["stat"; "/test"]], [CompareWithInt ("size", 1000)])],
3924 "truncate a file to a particular size",
3926 This command truncates C<path> to size C<size> bytes. The file
3927 must exist already. If the file is smaller than C<size> then
3928 the file is extended to the required size with null bytes.");
3930 ("utimens", (RErr, [Pathname "path"; Int64 "atsecs"; Int64 "atnsecs"; Int64 "mtsecs"; Int64 "mtnsecs"]), 201, [],
3931 [InitBasicFS, Always, TestOutputStruct (
3932 [["touch"; "/test"];
3933 ["utimens"; "/test"; "12345"; "67890"; "9876"; "5432"];
3934 ["stat"; "/test"]], [CompareWithInt ("mtime", 9876)])],
3935 "set timestamp of a file with nanosecond precision",
3937 This command sets the timestamps of a file with nanosecond
3940 C<atsecs, atnsecs> are the last access time (atime) in secs and
3941 nanoseconds from the epoch.
3943 C<mtsecs, mtnsecs> are the last modification time (mtime) in
3944 secs and nanoseconds from the epoch.
3946 If the C<*nsecs> field contains the special value C<-1> then
3947 the corresponding timestamp is set to the current time. (The
3948 C<*secs> field is ignored in this case).
3950 If the C<*nsecs> field contains the special value C<-2> then
3951 the corresponding timestamp is left unchanged. (The
3952 C<*secs> field is ignored in this case).");
3954 ("mkdir_mode", (RErr, [Pathname "path"; Int "mode"]), 202, [],
3955 [InitBasicFS, Always, TestOutputStruct (
3956 [["mkdir_mode"; "/test"; "0o111"];
3957 ["stat"; "/test"]], [CompareWithInt ("mode", 0o40111)])],
3958 "create a directory with a particular mode",
3960 This command creates a directory, setting the initial permissions
3961 of the directory to C<mode>.
3963 For common Linux filesystems, the actual mode which is set will
3964 be C<mode & ~umask & 01777>. Non-native-Linux filesystems may
3965 interpret the mode in other ways.
3967 See also C<guestfs_mkdir>, C<guestfs_umask>");
3969 ("lchown", (RErr, [Int "owner"; Int "group"; Pathname "path"]), 203, [],
3971 "change file owner and group",
3973 Change the file owner to C<owner> and group to C<group>.
3974 This is like C<guestfs_chown> but if C<path> is a symlink then
3975 the link itself is changed, not the target.
3977 Only numeric uid and gid are supported. If you want to use
3978 names, you will need to locate and parse the password file
3979 yourself (Augeas support makes this relatively easy).");
3981 ("lstatlist", (RStructList ("statbufs", "stat"), [Pathname "path"; StringList "names"]), 204, [],
3983 "lstat on multiple files",
3985 This call allows you to perform the C<guestfs_lstat> operation
3986 on multiple files, where all files are in the directory C<path>.
3987 C<names> is the list of files from this directory.
3989 On return you get a list of stat structs, with a one-to-one
3990 correspondence to the C<names> list. If any name did not exist
3991 or could not be lstat'd, then the C<ino> field of that structure
3994 This call is intended for programs that want to efficiently
3995 list a directory contents without making many round-trips.
3996 See also C<guestfs_lxattrlist> for a similarly efficient call
3997 for getting extended attributes. Very long directory listings
3998 might cause the protocol message size to be exceeded, causing
3999 this call to fail. The caller must split up such requests
4000 into smaller groups of names.");
4002 ("lxattrlist", (RStructList ("xattrs", "xattr"), [Pathname "path"; StringList "names"]), 205, [Optional "linuxxattrs"],
4004 "lgetxattr on multiple files",
4006 This call allows you to get the extended attributes
4007 of multiple files, where all files are in the directory C<path>.
4008 C<names> is the list of files from this directory.
4010 On return you get a flat list of xattr structs which must be
4011 interpreted sequentially. The first xattr struct always has a zero-length
4012 C<attrname>. C<attrval> in this struct is zero-length
4013 to indicate there was an error doing C<lgetxattr> for this
4014 file, I<or> is a C string which is a decimal number
4015 (the number of following attributes for this file, which could
4016 be C<\"0\">). Then after the first xattr struct are the
4017 zero or more attributes for the first named file.
4018 This repeats for the second and subsequent files.
4020 This call is intended for programs that want to efficiently
4021 list a directory contents without making many round-trips.
4022 See also C<guestfs_lstatlist> for a similarly efficient call
4023 for getting standard stats. Very long directory listings
4024 might cause the protocol message size to be exceeded, causing
4025 this call to fail. The caller must split up such requests
4026 into smaller groups of names.");
4028 ("readlinklist", (RStringList "links", [Pathname "path"; StringList "names"]), 206, [],
4030 "readlink on multiple files",
4032 This call allows you to do a C<readlink> operation
4033 on multiple files, where all files are in the directory C<path>.
4034 C<names> is the list of files from this directory.
4036 On return you get a list of strings, with a one-to-one
4037 correspondence to the C<names> list. Each string is the
4038 value of the symbol link.
4040 If the C<readlink(2)> operation fails on any name, then
4041 the corresponding result string is the empty string C<\"\">.
4042 However the whole operation is completed even if there
4043 were C<readlink(2)> errors, and so you can call this
4044 function with names where you don't know if they are
4045 symbolic links already (albeit slightly less efficient).
4047 This call is intended for programs that want to efficiently
4048 list a directory contents without making many round-trips.
4049 Very long directory listings might cause the protocol
4050 message size to be exceeded, causing
4051 this call to fail. The caller must split up such requests
4052 into smaller groups of names.");
4054 ("pread", (RBufferOut "content", [Pathname "path"; Int "count"; Int64 "offset"]), 207, [ProtocolLimitWarning],
4055 [InitISOFS, Always, TestOutputBuffer (
4056 [["pread"; "/known-4"; "1"; "3"]], "\n");
4057 InitISOFS, Always, TestOutputBuffer (
4058 [["pread"; "/empty"; "0"; "100"]], "")],
4059 "read part of a file",
4061 This command lets you read part of a file. It reads C<count>
4062 bytes of the file, starting at C<offset>, from file C<path>.
4064 This may read fewer bytes than requested. For further details
4065 see the L<pread(2)> system call.
4067 See also C<guestfs_pwrite>.");
4069 ("part_init", (RErr, [Device "device"; String "parttype"]), 208, [],
4070 [InitEmpty, Always, TestRun (
4071 [["part_init"; "/dev/sda"; "gpt"]])],
4072 "create an empty partition table",
4074 This creates an empty partition table on C<device> of one of the
4075 partition types listed below. Usually C<parttype> should be
4076 either C<msdos> or C<gpt> (for large disks).
4078 Initially there are no partitions. Following this, you should
4079 call C<guestfs_part_add> for each partition required.
4081 Possible values for C<parttype> are:
4085 =item B<efi> | B<gpt>
4087 Intel EFI / GPT partition table.
4089 This is recommended for >= 2 TB partitions that will be accessed
4090 from Linux and Intel-based Mac OS X. It also has limited backwards
4091 compatibility with the C<mbr> format.
4093 =item B<mbr> | B<msdos>
4095 The standard PC \"Master Boot Record\" (MBR) format used
4096 by MS-DOS and Windows. This partition type will B<only> work
4097 for device sizes up to 2 TB. For large disks we recommend
4102 Other partition table types that may work but are not
4111 =item B<amiga> | B<rdb>
4113 Amiga \"Rigid Disk Block\" format.
4121 DASD, used on IBM mainframes.
4129 Old Mac partition format. Modern Macs use C<gpt>.
4133 NEC PC-98 format, common in Japan apparently.
4141 ("part_add", (RErr, [Device "device"; String "prlogex"; Int64 "startsect"; Int64 "endsect"]), 209, [],
4142 [InitEmpty, Always, TestRun (
4143 [["part_init"; "/dev/sda"; "mbr"];
4144 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"]]);
4145 InitEmpty, Always, TestRun (
4146 [["part_init"; "/dev/sda"; "gpt"];
4147 ["part_add"; "/dev/sda"; "primary"; "34"; "127"];
4148 ["part_add"; "/dev/sda"; "primary"; "128"; "-34"]]);
4149 InitEmpty, Always, TestRun (
4150 [["part_init"; "/dev/sda"; "mbr"];
4151 ["part_add"; "/dev/sda"; "primary"; "32"; "127"];
4152 ["part_add"; "/dev/sda"; "primary"; "128"; "255"];
4153 ["part_add"; "/dev/sda"; "primary"; "256"; "511"];
4154 ["part_add"; "/dev/sda"; "primary"; "512"; "-1"]])],
4155 "add a partition to the device",
4157 This command adds a partition to C<device>. If there is no partition
4158 table on the device, call C<guestfs_part_init> first.
4160 The C<prlogex> parameter is the type of partition. Normally you
4161 should pass C<p> or C<primary> here, but MBR partition tables also
4162 support C<l> (or C<logical>) and C<e> (or C<extended>) partition
4165 C<startsect> and C<endsect> are the start and end of the partition
4166 in I<sectors>. C<endsect> may be negative, which means it counts
4167 backwards from the end of the disk (C<-1> is the last sector).
4169 Creating a partition which covers the whole disk is not so easy.
4170 Use C<guestfs_part_disk> to do that.");
4172 ("part_disk", (RErr, [Device "device"; String "parttype"]), 210, [DangerWillRobinson],
4173 [InitEmpty, Always, TestRun (
4174 [["part_disk"; "/dev/sda"; "mbr"]]);
4175 InitEmpty, Always, TestRun (
4176 [["part_disk"; "/dev/sda"; "gpt"]])],
4177 "partition whole disk with a single primary partition",
4179 This command is simply a combination of C<guestfs_part_init>
4180 followed by C<guestfs_part_add> to create a single primary partition
4181 covering the whole disk.
4183 C<parttype> is the partition table type, usually C<mbr> or C<gpt>,
4184 but other possible values are described in C<guestfs_part_init>.");
4186 ("part_set_bootable", (RErr, [Device "device"; Int "partnum"; Bool "bootable"]), 211, [],
4187 [InitEmpty, Always, TestRun (
4188 [["part_disk"; "/dev/sda"; "mbr"];
4189 ["part_set_bootable"; "/dev/sda"; "1"; "true"]])],
4190 "make a partition bootable",
4192 This sets the bootable flag on partition numbered C<partnum> on
4193 device C<device>. Note that partitions are numbered from 1.
4195 The bootable flag is used by some operating systems (notably
4196 Windows) to determine which partition to boot from. It is by
4197 no means universally recognized.");
4199 ("part_set_name", (RErr, [Device "device"; Int "partnum"; String "name"]), 212, [],
4200 [InitEmpty, Always, TestRun (
4201 [["part_disk"; "/dev/sda"; "gpt"];
4202 ["part_set_name"; "/dev/sda"; "1"; "thepartname"]])],
4203 "set partition name",
4205 This sets the partition name on partition numbered C<partnum> on
4206 device C<device>. Note that partitions are numbered from 1.
4208 The partition name can only be set on certain types of partition
4209 table. This works on C<gpt> but not on C<mbr> partitions.");
4211 ("part_list", (RStructList ("partitions", "partition"), [Device "device"]), 213, [],
4212 [], (* XXX Add a regression test for this. *)
4213 "list partitions on a device",
4215 This command parses the partition table on C<device> and
4216 returns the list of partitions found.
4218 The fields in the returned structure are:
4224 Partition number, counting from 1.
4228 Start of the partition I<in bytes>. To get sectors you have to
4229 divide by the device's sector size, see C<guestfs_blockdev_getss>.
4233 End of the partition in bytes.
4237 Size of the partition in bytes.
4241 ("part_get_parttype", (RString "parttype", [Device "device"]), 214, [],
4242 [InitEmpty, Always, TestOutput (
4243 [["part_disk"; "/dev/sda"; "gpt"];
4244 ["part_get_parttype"; "/dev/sda"]], "gpt")],
4245 "get the partition table type",
4247 This command examines the partition table on C<device> and
4248 returns the partition table type (format) being used.
4250 Common return values include: C<msdos> (a DOS/Windows style MBR
4251 partition table), C<gpt> (a GPT/EFI-style partition table). Other
4252 values are possible, although unusual. See C<guestfs_part_init>
4255 ("fill", (RErr, [Int "c"; Int "len"; Pathname "path"]), 215, [],
4256 [InitBasicFS, Always, TestOutputBuffer (
4257 [["fill"; "0x63"; "10"; "/test"];
4258 ["read_file"; "/test"]], "cccccccccc")],
4259 "fill a file with octets",
4261 This command creates a new file called C<path>. The initial
4262 content of the file is C<len> octets of C<c>, where C<c>
4263 must be a number in the range C<[0..255]>.
4265 To fill a file with zero bytes (sparsely), it is
4266 much more efficient to use C<guestfs_truncate_size>.
4267 To create a file with a pattern of repeating bytes
4268 use C<guestfs_fill_pattern>.");
4270 ("available", (RErr, [StringList "groups"]), 216, [],
4271 [InitNone, Always, TestRun [["available"; ""]]],
4272 "test availability of some parts of the API",
4274 This command is used to check the availability of some
4275 groups of functionality in the appliance, which not all builds of
4276 the libguestfs appliance will be able to provide.
4278 The libguestfs groups, and the functions that those
4279 groups correspond to, are listed in L<guestfs(3)/AVAILABILITY>.
4281 The argument C<groups> is a list of group names, eg:
4282 C<[\"inotify\", \"augeas\"]> would check for the availability of
4283 the Linux inotify functions and Augeas (configuration file
4286 The command returns no error if I<all> requested groups are available.
4288 It fails with an error if one or more of the requested
4289 groups is unavailable in the appliance.
4291 If an unknown group name is included in the
4292 list of groups then an error is always returned.
4300 You must call C<guestfs_launch> before calling this function.
4302 The reason is because we don't know what groups are
4303 supported by the appliance/daemon until it is running and can
4308 If a group of functions is available, this does not necessarily
4309 mean that they will work. You still have to check for errors
4310 when calling individual API functions even if they are
4315 It is usually the job of distro packagers to build
4316 complete functionality into the libguestfs appliance.
4317 Upstream libguestfs, if built from source with all
4318 requirements satisfied, will support everything.
4322 This call was added in version C<1.0.80>. In previous
4323 versions of libguestfs all you could do would be to speculatively
4324 execute a command to find out if the daemon implemented it.
4325 See also C<guestfs_version>.
4329 ("dd", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"]), 217, [],
4330 [InitBasicFS, Always, TestOutputBuffer (
4331 [["write"; "/src"; "hello, world"];
4332 ["dd"; "/src"; "/dest"];
4333 ["read_file"; "/dest"]], "hello, world")],
4334 "copy from source to destination using dd",
4336 This command copies from one source device or file C<src>
4337 to another destination device or file C<dest>. Normally you
4338 would use this to copy to or from a device or partition, for
4339 example to duplicate a filesystem.
4341 If the destination is a device, it must be as large or larger
4342 than the source file or device, otherwise the copy will fail.
4343 This command cannot do partial copies (see C<guestfs_copy_size>).");
4345 ("filesize", (RInt64 "size", [Pathname "file"]), 218, [],
4346 [InitBasicFS, Always, TestOutputInt (
4347 [["write"; "/file"; "hello, world"];
4348 ["filesize"; "/file"]], 12)],
4349 "return the size of the file in bytes",
4351 This command returns the size of C<file> in bytes.
4353 To get other stats about a file, use C<guestfs_stat>, C<guestfs_lstat>,
4354 C<guestfs_is_dir>, C<guestfs_is_file> etc.
4355 To get the size of block devices, use C<guestfs_blockdev_getsize64>.");
4357 ("lvrename", (RErr, [String "logvol"; String "newlogvol"]), 219, [],
4358 [InitBasicFSonLVM, Always, TestOutputList (
4359 [["lvrename"; "/dev/VG/LV"; "/dev/VG/LV2"];
4360 ["lvs"]], ["/dev/VG/LV2"])],
4361 "rename an LVM logical volume",
4363 Rename a logical volume C<logvol> with the new name C<newlogvol>.");
4365 ("vgrename", (RErr, [String "volgroup"; String "newvolgroup"]), 220, [],
4366 [InitBasicFSonLVM, Always, TestOutputList (
4368 ["vg_activate"; "false"; "VG"];
4369 ["vgrename"; "VG"; "VG2"];
4370 ["vg_activate"; "true"; "VG2"];
4371 ["mount_options"; ""; "/dev/VG2/LV"; "/"];
4372 ["vgs"]], ["VG2"])],
4373 "rename an LVM volume group",
4375 Rename a volume group C<volgroup> with the new name C<newvolgroup>.");
4377 ("initrd_cat", (RBufferOut "content", [Pathname "initrdpath"; String "filename"]), 221, [ProtocolLimitWarning],
4378 [InitISOFS, Always, TestOutputBuffer (
4379 [["initrd_cat"; "/initrd"; "known-4"]], "abc\ndef\nghi")],
4380 "list the contents of a single file in an initrd",
4382 This command unpacks the file C<filename> from the initrd file
4383 called C<initrdpath>. The filename must be given I<without> the
4384 initial C</> character.
4386 For example, in guestfish you could use the following command
4387 to examine the boot script (usually called C</init>)
4388 contained in a Linux initrd or initramfs image:
4390 initrd-cat /boot/initrd-<version>.img init
4392 See also C<guestfs_initrd_list>.");
4394 ("pvuuid", (RString "uuid", [Device "device"]), 222, [],
4396 "get the UUID of a physical volume",
4398 This command returns the UUID of the LVM PV C<device>.");
4400 ("vguuid", (RString "uuid", [String "vgname"]), 223, [],
4402 "get the UUID of a volume group",
4404 This command returns the UUID of the LVM VG named C<vgname>.");
4406 ("lvuuid", (RString "uuid", [Device "device"]), 224, [],
4408 "get the UUID of a logical volume",
4410 This command returns the UUID of the LVM LV C<device>.");
4412 ("vgpvuuids", (RStringList "uuids", [String "vgname"]), 225, [],
4414 "get the PV UUIDs containing the volume group",
4416 Given a VG called C<vgname>, this returns the UUIDs of all
4417 the physical volumes that this volume group resides on.
4419 You can use this along with C<guestfs_pvs> and C<guestfs_pvuuid>
4420 calls to associate physical volumes and volume groups.
4422 See also C<guestfs_vglvuuids>.");
4424 ("vglvuuids", (RStringList "uuids", [String "vgname"]), 226, [],
4426 "get the LV UUIDs of all LVs in the volume group",
4428 Given a VG called C<vgname>, this returns the UUIDs of all
4429 the logical volumes created in this volume group.
4431 You can use this along with C<guestfs_lvs> and C<guestfs_lvuuid>
4432 calls to associate logical volumes and volume groups.
4434 See also C<guestfs_vgpvuuids>.");
4436 ("copy_size", (RErr, [Dev_or_Path "src"; Dev_or_Path "dest"; Int64 "size"]), 227, [],
4437 [InitBasicFS, Always, TestOutputBuffer (
4438 [["write"; "/src"; "hello, world"];
4439 ["copy_size"; "/src"; "/dest"; "5"];
4440 ["read_file"; "/dest"]], "hello")],
4441 "copy size bytes from source to destination using dd",
4443 This command copies exactly C<size> bytes from one source device
4444 or file C<src> to another destination device or file C<dest>.
4446 Note this will fail if the source is too short or if the destination
4447 is not large enough.");
4449 ("zero_device", (RErr, [Device "device"]), 228, [DangerWillRobinson],
4450 [InitBasicFSonLVM, Always, TestRun (
4451 [["zero_device"; "/dev/VG/LV"]])],
4452 "write zeroes to an entire device",
4454 This command writes zeroes over the entire C<device>. Compare
4455 with C<guestfs_zero> which just zeroes the first few blocks of
4458 ("txz_in", (RErr, [FileIn "tarball"; Pathname "directory"]), 229, [],
4459 [InitBasicFS, Always, TestOutput (
4460 [["txz_in"; "../images/helloworld.tar.xz"; "/"];
4461 ["cat"; "/hello"]], "hello\n")],
4462 "unpack compressed tarball to directory",
4464 This command uploads and unpacks local file C<tarball> (an
4465 I<xz compressed> tar file) into C<directory>.");
4467 ("txz_out", (RErr, [Pathname "directory"; FileOut "tarball"]), 230, [],
4469 "pack directory into compressed tarball",
4471 This command packs the contents of C<directory> and downloads
4472 it to local file C<tarball> (as an xz compressed tar archive).");
4474 ("ntfsresize", (RErr, [Device "device"]), 231, [Optional "ntfsprogs"],
4476 "resize an NTFS filesystem",
4478 This command resizes an NTFS filesystem, expanding or
4479 shrinking it to the size of the underlying device.
4480 See also L<ntfsresize(8)>.");
4482 ("vgscan", (RErr, []), 232, [],
4483 [InitEmpty, Always, TestRun (
4485 "rescan for LVM physical volumes, volume groups and logical volumes",
4487 This rescans all block devices and rebuilds the list of LVM
4488 physical volumes, volume groups and logical volumes.");
4490 ("part_del", (RErr, [Device "device"; Int "partnum"]), 233, [],
4491 [InitEmpty, Always, TestRun (
4492 [["part_init"; "/dev/sda"; "mbr"];
4493 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4494 ["part_del"; "/dev/sda"; "1"]])],
4495 "delete a partition",
4497 This command deletes the partition numbered C<partnum> on C<device>.
4499 Note that in the case of MBR partitioning, deleting an
4500 extended partition also deletes any logical partitions
4503 ("part_get_bootable", (RBool "bootable", [Device "device"; Int "partnum"]), 234, [],
4504 [InitEmpty, Always, TestOutputTrue (
4505 [["part_init"; "/dev/sda"; "mbr"];
4506 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4507 ["part_set_bootable"; "/dev/sda"; "1"; "true"];
4508 ["part_get_bootable"; "/dev/sda"; "1"]])],
4509 "return true if a partition is bootable",
4511 This command returns true if the partition C<partnum> on
4512 C<device> has the bootable flag set.
4514 See also C<guestfs_part_set_bootable>.");
4516 ("part_get_mbr_id", (RInt "idbyte", [Device "device"; Int "partnum"]), 235, [FishOutput FishOutputHexadecimal],
4517 [InitEmpty, Always, TestOutputInt (
4518 [["part_init"; "/dev/sda"; "mbr"];
4519 ["part_add"; "/dev/sda"; "primary"; "1"; "-1"];
4520 ["part_set_mbr_id"; "/dev/sda"; "1"; "0x7f"];
4521 ["part_get_mbr_id"; "/dev/sda"; "1"]], 0x7f)],
4522 "get the MBR type byte (ID byte) from a partition",
4524 Returns the MBR type byte (also known as the ID byte) from
4525 the numbered partition C<partnum>.
4527 Note that only MBR (old DOS-style) partitions have type bytes.
4528 You will get undefined results for other partition table
4529 types (see C<guestfs_part_get_parttype>).");
4531 ("part_set_mbr_id", (RErr, [Device "device"; Int "partnum"; Int "idbyte"]), 236, [],
4532 [], (* tested by part_get_mbr_id *)
4533 "set the MBR type byte (ID byte) of a partition",
4535 Sets the MBR type byte (also known as the ID byte) of
4536 the numbered partition C<partnum> to C<idbyte>. Note
4537 that the type bytes quoted in most documentation are
4538 in fact hexadecimal numbers, but usually documented
4539 without any leading \"0x\" which might be confusing.
4541 Note that only MBR (old DOS-style) partitions have type bytes.
4542 You will get undefined results for other partition table
4543 types (see C<guestfs_part_get_parttype>).");
4545 ("checksum_device", (RString "checksum", [String "csumtype"; Device "device"]), 237, [],
4546 [InitISOFS, Always, TestOutput (
4547 [["checksum_device"; "md5"; "/dev/sdd"]],
4548 (Digest.to_hex (Digest.file "images/test.iso")))],
4549 "compute MD5, SHAx or CRC checksum of the contents of a device",
4551 This call computes the MD5, SHAx or CRC checksum of the
4552 contents of the device named C<device>. For the types of
4553 checksums supported see the C<guestfs_checksum> command.");
4555 ("lvresize_free", (RErr, [Device "lv"; Int "percent"]), 238, [Optional "lvm2"],
4556 [InitNone, Always, TestRun (
4557 [["part_disk"; "/dev/sda"; "mbr"];
4558 ["pvcreate"; "/dev/sda1"];
4559 ["vgcreate"; "VG"; "/dev/sda1"];
4560 ["lvcreate"; "LV"; "VG"; "10"];
4561 ["lvresize_free"; "/dev/VG/LV"; "100"]])],
4562 "expand an LV to fill free space",
4564 This expands an existing logical volume C<lv> so that it fills
4565 C<pc>% of the remaining free space in the volume group. Commonly
4566 you would call this with pc = 100 which expands the logical volume
4567 as much as possible, using all remaining free space in the volume
4570 ("aug_clear", (RErr, [String "augpath"]), 239, [Optional "augeas"],
4571 [], (* XXX Augeas code needs tests. *)
4572 "clear Augeas path",
4574 Set the value associated with C<path> to C<NULL>. This
4575 is the same as the L<augtool(1)> C<clear> command.");
4577 ("get_umask", (RInt "mask", []), 240, [FishOutput FishOutputOctal],
4578 [InitEmpty, Always, TestOutputInt (
4579 [["get_umask"]], 0o22)],
4580 "get the current umask",
4582 Return the current umask. By default the umask is C<022>
4583 unless it has been set by calling C<guestfs_umask>.");
4585 ("debug_upload", (RErr, [FileIn "filename"; String "tmpname"; Int "mode"]), 241, [],
4587 "upload a file to the appliance (internal use only)",
4589 The C<guestfs_debug_upload> command uploads a file to
4590 the libguestfs appliance.
4592 There is no comprehensive help for this command. You have
4593 to look at the file C<daemon/debug.c> in the libguestfs source
4594 to find out what it is for.");
4596 ("base64_in", (RErr, [FileIn "base64file"; Pathname "filename"]), 242, [],
4597 [InitBasicFS, Always, TestOutput (
4598 [["base64_in"; "../images/hello.b64"; "/hello"];
4599 ["cat"; "/hello"]], "hello\n")],
4600 "upload base64-encoded data to file",
4602 This command uploads base64-encoded data from C<base64file>
4605 ("base64_out", (RErr, [Pathname "filename"; FileOut "base64file"]), 243, [],
4607 "download file and encode as base64",
4609 This command downloads the contents of C<filename>, writing
4610 it out to local file C<base64file> encoded as base64.");
4612 ("checksums_out", (RErr, [String "csumtype"; Pathname "directory"; FileOut "sumsfile"]), 244, [],
4614 "compute MD5, SHAx or CRC checksum of files in a directory",
4616 This command computes the checksums of all regular files in
4617 C<directory> and then emits a list of those checksums to
4618 the local output file C<sumsfile>.
4620 This can be used for verifying the integrity of a virtual
4621 machine. However to be properly secure you should pay
4622 attention to the output of the checksum command (it uses
4623 the ones from GNU coreutils). In particular when the
4624 filename is not printable, coreutils uses a special
4625 backslash syntax. For more information, see the GNU
4626 coreutils info file.");
4628 ("fill_pattern", (RErr, [String "pattern"; Int "len"; Pathname "path"]), 245, [],
4629 [InitBasicFS, Always, TestOutputBuffer (
4630 [["fill_pattern"; "abcdefghijklmnopqrstuvwxyz"; "28"; "/test"];
4631 ["read_file"; "/test"]], "abcdefghijklmnopqrstuvwxyzab")],
4632 "fill a file with a repeating pattern of bytes",
4634 This function is like C<guestfs_fill> except that it creates
4635 a new file of length C<len> containing the repeating pattern
4636 of bytes in C<pattern>. The pattern is truncated if necessary
4637 to ensure the length of the file is exactly C<len> bytes.");
4639 ("write", (RErr, [Pathname "path"; BufferIn "content"]), 246, [ProtocolLimitWarning],
4640 [InitBasicFS, Always, TestOutput (
4641 [["write"; "/new"; "new file contents"];
4642 ["cat"; "/new"]], "new file contents");
4643 InitBasicFS, Always, TestOutput (
4644 [["write"; "/new"; "\nnew file contents\n"];
4645 ["cat"; "/new"]], "\nnew file contents\n");
4646 InitBasicFS, Always, TestOutput (
4647 [["write"; "/new"; "\n\n"];
4648 ["cat"; "/new"]], "\n\n");
4649 InitBasicFS, Always, TestOutput (
4650 [["write"; "/new"; ""];
4651 ["cat"; "/new"]], "");
4652 InitBasicFS, Always, TestOutput (
4653 [["write"; "/new"; "\n\n\n"];
4654 ["cat"; "/new"]], "\n\n\n");
4655 InitBasicFS, Always, TestOutput (
4656 [["write"; "/new"; "\n"];
4657 ["cat"; "/new"]], "\n")],
4658 "create a new file",
4660 This call creates a file called C<path>. The content of the
4661 file is the string C<content> (which can contain any 8 bit data).");
4663 ("pwrite", (RInt "nbytes", [Pathname "path"; BufferIn "content"; Int64 "offset"]), 247, [ProtocolLimitWarning],
4664 [InitBasicFS, Always, TestOutput (
4665 [["write"; "/new"; "new file contents"];
4666 ["pwrite"; "/new"; "data"; "4"];
4667 ["cat"; "/new"]], "new data contents");
4668 InitBasicFS, Always, TestOutput (
4669 [["write"; "/new"; "new file contents"];
4670 ["pwrite"; "/new"; "is extended"; "9"];
4671 ["cat"; "/new"]], "new file is extended");
4672 InitBasicFS, Always, TestOutput (
4673 [["write"; "/new"; "new file contents"];
4674 ["pwrite"; "/new"; ""; "4"];
4675 ["cat"; "/new"]], "new file contents")],
4676 "write to part of a file",
4678 This command writes to part of a file. It writes the data
4679 buffer C<content> to the file C<path> starting at offset C<offset>.
4681 This command implements the L<pwrite(2)> system call, and like
4682 that system call it may not write the full data requested. The
4683 return value is the number of bytes that were actually written
4684 to the file. This could even be 0, although short writes are
4685 unlikely for regular files in ordinary circumstances.
4687 See also C<guestfs_pread>.");
4691 let all_functions = non_daemon_functions @ daemon_functions
4693 (* In some places we want the functions to be displayed sorted
4694 * alphabetically, so this is useful:
4696 let all_functions_sorted =
4697 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4698 compare n1 n2) all_functions
4700 (* This is used to generate the src/MAX_PROC_NR file which
4701 * contains the maximum procedure number, a surrogate for the
4702 * ABI version number. See src/Makefile.am for the details.
4705 let proc_nrs = List.map (
4706 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4707 ) daemon_functions in
4708 List.fold_left max 0 proc_nrs
4710 (* Field types for structures. *)
4712 | FChar (* C 'char' (really, a 7 bit byte). *)
4713 | FString (* nul-terminated ASCII string, NOT NULL. *)
4714 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4719 | FBytes (* Any int measure that counts bytes. *)
4720 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4721 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4723 (* Because we generate extra parsing code for LVM command line tools,
4724 * we have to pull out the LVM columns separately here.
4734 "pv_attr", FString (* XXX *);
4735 "pv_pe_count", FInt64;
4736 "pv_pe_alloc_count", FInt64;
4739 "pv_mda_count", FInt64;
4740 "pv_mda_free", FBytes;
4741 (* Not in Fedora 10:
4742 "pv_mda_size", FBytes;
4749 "vg_attr", FString (* XXX *);
4752 "vg_sysid", FString;
4753 "vg_extent_size", FBytes;
4754 "vg_extent_count", FInt64;
4755 "vg_free_count", FInt64;
4760 "snap_count", FInt64;
4763 "vg_mda_count", FInt64;
4764 "vg_mda_free", FBytes;
4765 (* Not in Fedora 10:
4766 "vg_mda_size", FBytes;
4772 "lv_attr", FString (* XXX *);
4775 "lv_kernel_major", FInt64;
4776 "lv_kernel_minor", FInt64;
4778 "seg_count", FInt64;
4780 "snap_percent", FOptPercent;
4781 "copy_percent", FOptPercent;
4784 "mirror_log", FString;
4788 (* Names and fields in all structures (in RStruct and RStructList)
4792 (* The old RIntBool return type, only ever used for aug_defnode. Do
4793 * not use this struct in any new code.
4796 "i", FInt32; (* for historical compatibility *)
4797 "b", FInt32; (* for historical compatibility *)
4800 (* LVM PVs, VGs, LVs. *)
4801 "lvm_pv", lvm_pv_cols;
4802 "lvm_vg", lvm_vg_cols;
4803 "lvm_lv", lvm_lv_cols;
4805 (* Column names and types from stat structures.
4806 * NB. Can't use things like 'st_atime' because glibc header files
4807 * define some of these as macros. Ugh.
4838 (* Column names in dirent structure. *)
4841 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4846 (* Version numbers. *)
4854 (* Extended attribute. *)
4856 "attrname", FString;
4860 (* Inotify events. *)
4864 "in_cookie", FUInt32;
4868 (* Partition table entry. *)
4871 "part_start", FBytes;
4873 "part_size", FBytes;
4875 ] (* end of structs *)
4877 (* Ugh, Java has to be different ..
4878 * These names are also used by the Haskell bindings.
4880 let java_structs = [
4881 "int_bool", "IntBool";
4886 "statvfs", "StatVFS";
4888 "version", "Version";
4890 "inotify_event", "INotifyEvent";
4891 "partition", "Partition";
4894 (* What structs are actually returned. *)
4895 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4897 (* Returns a list of RStruct/RStructList structs that are returned
4898 * by any function. Each element of returned list is a pair:
4900 * (structname, RStructOnly)
4901 * == there exists function which returns RStruct (_, structname)
4902 * (structname, RStructListOnly)
4903 * == there exists function which returns RStructList (_, structname)
4904 * (structname, RStructAndList)
4905 * == there are functions returning both RStruct (_, structname)
4906 * and RStructList (_, structname)
4908 let rstructs_used_by functions =
4909 (* ||| is a "logical OR" for rstructs_used_t *)
4913 | _, RStructAndList -> RStructAndList
4914 | RStructOnly, RStructListOnly
4915 | RStructListOnly, RStructOnly -> RStructAndList
4916 | RStructOnly, RStructOnly -> RStructOnly
4917 | RStructListOnly, RStructListOnly -> RStructListOnly
4920 let h = Hashtbl.create 13 in
4922 (* if elem->oldv exists, update entry using ||| operator,
4923 * else just add elem->newv to the hash
4925 let update elem newv =
4926 try let oldv = Hashtbl.find h elem in
4927 Hashtbl.replace h elem (newv ||| oldv)
4928 with Not_found -> Hashtbl.add h elem newv
4932 fun (_, style, _, _, _, _, _) ->
4933 match fst style with
4934 | RStruct (_, structname) -> update structname RStructOnly
4935 | RStructList (_, structname) -> update structname RStructListOnly
4939 (* return key->values as a list of (key,value) *)
4940 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4942 (* Used for testing language bindings. *)
4944 | CallString of string
4945 | CallOptString of string option
4946 | CallStringList of string list
4948 | CallInt64 of int64
4950 | CallBuffer of string
4952 (* Used to memoize the result of pod2text. *)
4953 let pod2text_memo_filename = "src/.pod2text.data"
4954 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4956 let chan = open_in pod2text_memo_filename in
4957 let v = input_value chan in
4961 _ -> Hashtbl.create 13
4962 let pod2text_memo_updated () =
4963 let chan = open_out pod2text_memo_filename in
4964 output_value chan pod2text_memo;
4967 (* Useful functions.
4968 * Note we don't want to use any external OCaml libraries which
4969 * makes this a bit harder than it should be.
4971 module StringMap = Map.Make (String)
4973 let failwithf fs = ksprintf failwith fs
4975 let unique = let i = ref 0 in fun () -> incr i; !i
4977 let replace_char s c1 c2 =
4978 let s2 = String.copy s in
4979 let r = ref false in
4980 for i = 0 to String.length s2 - 1 do
4981 if String.unsafe_get s2 i = c1 then (
4982 String.unsafe_set s2 i c2;
4986 if not !r then s else s2
4990 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
4992 let triml ?(test = isspace) str =
4994 let n = ref (String.length str) in
4995 while !n > 0 && test str.[!i]; do
5000 else String.sub str !i !n
5002 let trimr ?(test = isspace) str =
5003 let n = ref (String.length str) in
5004 while !n > 0 && test str.[!n-1]; do
5007 if !n = String.length str then str
5008 else String.sub str 0 !n
5010 let trim ?(test = isspace) str =
5011 trimr ~test (triml ~test str)
5013 let rec find s sub =
5014 let len = String.length s in
5015 let sublen = String.length sub in
5017 if i <= len-sublen then (
5019 if j < sublen then (
5020 if s.[i+j] = sub.[j] then loop2 (j+1)
5026 if r = -1 then loop (i+1) else r
5032 let rec replace_str s s1 s2 =
5033 let len = String.length s in
5034 let sublen = String.length s1 in
5035 let i = find s s1 in
5038 let s' = String.sub s 0 i in
5039 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5040 s' ^ s2 ^ replace_str s'' s1 s2
5043 let rec string_split sep str =
5044 let len = String.length str in
5045 let seplen = String.length sep in
5046 let i = find str sep in
5047 if i = -1 then [str]
5049 let s' = String.sub str 0 i in
5050 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5051 s' :: string_split sep s''
5054 let files_equal n1 n2 =
5055 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5056 match Sys.command cmd with
5059 | i -> failwithf "%s: failed with error code %d" cmd i
5061 let rec filter_map f = function
5065 | Some y -> y :: filter_map f xs
5066 | None -> filter_map f xs
5068 let rec find_map f = function
5069 | [] -> raise Not_found
5073 | None -> find_map f xs
5076 let rec loop i = function
5078 | x :: xs -> f i x; loop (i+1) xs
5083 let rec loop i = function
5085 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5089 let count_chars c str =
5090 let count = ref 0 in
5091 for i = 0 to String.length str - 1 do
5092 if c = String.unsafe_get str i then incr count
5098 for i = 0 to String.length str - 1 do
5099 let c = String.unsafe_get str i in
5104 let map_chars f str =
5105 List.map f (explode str)
5107 let name_of_argt = function
5108 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5109 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5110 | FileIn n | FileOut n | BufferIn n -> n
5112 let java_name_of_struct typ =
5113 try List.assoc typ java_structs
5116 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5118 let cols_of_struct typ =
5119 try List.assoc typ structs
5121 failwithf "cols_of_struct: unknown struct %s" typ
5123 let seq_of_test = function
5124 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5125 | TestOutputListOfDevices (s, _)
5126 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5127 | TestOutputTrue s | TestOutputFalse s
5128 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5129 | TestOutputStruct (s, _)
5130 | TestLastFail s -> s
5132 (* Handling for function flags. *)
5133 let protocol_limit_warning =
5134 "Because of the message protocol, there is a transfer limit
5135 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5137 let danger_will_robinson =
5138 "B<This command is dangerous. Without careful use you
5139 can easily destroy all your data>."
5141 let deprecation_notice flags =
5144 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5146 sprintf "This function is deprecated.
5147 In new code, use the C<%s> call instead.
5149 Deprecated functions will not be removed from the API, but the
5150 fact that they are deprecated indicates that there are problems
5151 with correct use of these functions." alt in
5156 (* Create list of optional groups. *)
5158 let h = Hashtbl.create 13 in
5160 fun (name, _, _, flags, _, _, _) ->
5164 let names = try Hashtbl.find h group with Not_found -> [] in
5165 Hashtbl.replace h group (name :: names)
5169 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5172 fun group -> group, List.sort compare (Hashtbl.find h group)
5174 List.sort (fun x y -> compare (fst x) (fst y)) groups
5176 (* Check function names etc. for consistency. *)
5177 let check_functions () =
5178 let contains_uppercase str =
5179 let len = String.length str in
5181 if i >= len then false
5184 if c >= 'A' && c <= 'Z' then true
5191 (* Check function names. *)
5193 fun (name, _, _, _, _, _, _) ->
5194 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5195 failwithf "function name %s does not need 'guestfs' prefix" name;
5197 failwithf "function name is empty";
5198 if name.[0] < 'a' || name.[0] > 'z' then
5199 failwithf "function name %s must start with lowercase a-z" name;
5200 if String.contains name '-' then
5201 failwithf "function name %s should not contain '-', use '_' instead."
5205 (* Check function parameter/return names. *)
5207 fun (name, style, _, _, _, _, _) ->
5208 let check_arg_ret_name n =
5209 if contains_uppercase n then
5210 failwithf "%s param/ret %s should not contain uppercase chars"
5212 if String.contains n '-' || String.contains n '_' then
5213 failwithf "%s param/ret %s should not contain '-' or '_'"
5216 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;
5217 if n = "int" || n = "char" || n = "short" || n = "long" then
5218 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5219 if n = "i" || n = "n" then
5220 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5221 if n = "argv" || n = "args" then
5222 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5224 (* List Haskell, OCaml and C keywords here.
5225 * http://www.haskell.org/haskellwiki/Keywords
5226 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5227 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5228 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5229 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5230 * Omitting _-containing words, since they're handled above.
5231 * Omitting the OCaml reserved word, "val", is ok,
5232 * and saves us from renaming several parameters.
5235 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5236 "char"; "class"; "const"; "constraint"; "continue"; "data";
5237 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5238 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5239 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5240 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5241 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5243 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5244 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5245 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5246 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5247 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5248 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5249 "volatile"; "when"; "where"; "while";
5251 if List.mem n reserved then
5252 failwithf "%s has param/ret using reserved word %s" name n;
5255 (match fst style with
5257 | RInt n | RInt64 n | RBool n
5258 | RConstString n | RConstOptString n | RString n
5259 | RStringList n | RStruct (n, _) | RStructList (n, _)
5260 | RHashtable n | RBufferOut n ->
5261 check_arg_ret_name n
5263 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5266 (* Check short descriptions. *)
5268 fun (name, _, _, _, _, shortdesc, _) ->
5269 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5270 failwithf "short description of %s should begin with lowercase." name;
5271 let c = shortdesc.[String.length shortdesc-1] in
5272 if c = '\n' || c = '.' then
5273 failwithf "short description of %s should not end with . or \\n." name
5276 (* Check long descriptions. *)
5278 fun (name, _, _, _, _, _, longdesc) ->
5279 if longdesc.[String.length longdesc-1] = '\n' then
5280 failwithf "long description of %s should not end with \\n." name
5283 (* Check proc_nrs. *)
5285 fun (name, _, proc_nr, _, _, _, _) ->
5286 if proc_nr <= 0 then
5287 failwithf "daemon function %s should have proc_nr > 0" name
5291 fun (name, _, proc_nr, _, _, _, _) ->
5292 if proc_nr <> -1 then
5293 failwithf "non-daemon function %s should have proc_nr -1" name
5294 ) non_daemon_functions;
5297 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5300 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5301 let rec loop = function
5304 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5306 | (name1,nr1) :: (name2,nr2) :: _ ->
5307 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5315 (* Ignore functions that have no tests. We generate a
5316 * warning when the user does 'make check' instead.
5318 | name, _, _, _, [], _, _ -> ()
5319 | name, _, _, _, tests, _, _ ->
5323 match seq_of_test test with
5325 failwithf "%s has a test containing an empty sequence" name
5326 | cmds -> List.map List.hd cmds
5328 let funcs = List.flatten funcs in
5330 let tested = List.mem name funcs in
5333 failwithf "function %s has tests but does not test itself" name
5336 (* 'pr' prints to the current output file. *)
5337 let chan = ref Pervasives.stdout
5342 let i = count_chars '\n' str in
5343 lines := !lines + i;
5344 output_string !chan str
5347 let copyright_years =
5348 let this_year = 1900 + (localtime (time ())).tm_year in
5349 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5351 (* Generate a header block in a number of standard styles. *)
5352 type comment_style =
5353 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5354 type license = GPLv2plus | LGPLv2plus
5356 let generate_header ?(extra_inputs = []) comment license =
5357 let inputs = "src/generator.ml" :: extra_inputs in
5358 let c = match comment with
5359 | CStyle -> pr "/* "; " *"
5360 | CPlusPlusStyle -> pr "// "; "//"
5361 | HashStyle -> pr "# "; "#"
5362 | OCamlStyle -> pr "(* "; " *"
5363 | HaskellStyle -> pr "{- "; " " in
5364 pr "libguestfs generated file\n";
5365 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5366 List.iter (pr "%s %s\n" c) inputs;
5367 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5369 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5373 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5374 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5375 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5376 pr "%s (at your option) any later version.\n" c;
5378 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5379 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5380 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5381 pr "%s GNU General Public License for more details.\n" c;
5383 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5384 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5385 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5388 pr "%s This library is free software; you can redistribute it and/or\n" c;
5389 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5390 pr "%s License as published by the Free Software Foundation; either\n" c;
5391 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5393 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5394 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5395 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5396 pr "%s Lesser General Public License for more details.\n" c;
5398 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5399 pr "%s License along with this library; if not, write to the Free Software\n" c;
5400 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5403 | CStyle -> pr " */\n"
5406 | OCamlStyle -> pr " *)\n"
5407 | HaskellStyle -> pr "-}\n"
5411 (* Start of main code generation functions below this line. *)
5413 (* Generate the pod documentation for the C API. *)
5414 let rec generate_actions_pod () =
5416 fun (shortname, style, _, flags, _, _, longdesc) ->
5417 if not (List.mem NotInDocs flags) then (
5418 let name = "guestfs_" ^ shortname in
5419 pr "=head2 %s\n\n" name;
5421 generate_prototype ~extern:false ~handle:"g" name style;
5423 pr "%s\n\n" longdesc;
5424 (match fst style with
5426 pr "This function returns 0 on success or -1 on error.\n\n"
5428 pr "On error this function returns -1.\n\n"
5430 pr "On error this function returns -1.\n\n"
5432 pr "This function returns a C truth value on success or -1 on error.\n\n"
5434 pr "This function returns a string, or NULL on error.
5435 The string is owned by the guest handle and must I<not> be freed.\n\n"
5436 | RConstOptString _ ->
5437 pr "This function returns a string which may be NULL.
5438 There is way to return an error from this function.
5439 The string is owned by the guest handle and must I<not> be freed.\n\n"
5441 pr "This function returns a string, or NULL on error.
5442 I<The caller must free the returned string after use>.\n\n"
5444 pr "This function returns a NULL-terminated array of strings
5445 (like L<environ(3)>), or NULL if there was an error.
5446 I<The caller must free the strings and the array after use>.\n\n"
5447 | RStruct (_, typ) ->
5448 pr "This function returns a C<struct guestfs_%s *>,
5449 or NULL if there was an error.
5450 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5451 | RStructList (_, typ) ->
5452 pr "This function returns a C<struct guestfs_%s_list *>
5453 (see E<lt>guestfs-structs.hE<gt>),
5454 or NULL if there was an error.
5455 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5457 pr "This function returns a NULL-terminated array of
5458 strings, or NULL if there was an error.
5459 The array of strings will always have length C<2n+1>, where
5460 C<n> keys and values alternate, followed by the trailing NULL entry.
5461 I<The caller must free the strings and the array after use>.\n\n"
5463 pr "This function returns a buffer, or NULL on error.
5464 The size of the returned buffer is written to C<*size_r>.
5465 I<The caller must free the returned buffer after use>.\n\n"
5467 if List.mem ProtocolLimitWarning flags then
5468 pr "%s\n\n" protocol_limit_warning;
5469 if List.mem DangerWillRobinson flags then
5470 pr "%s\n\n" danger_will_robinson;
5471 match deprecation_notice flags with
5473 | Some txt -> pr "%s\n\n" txt
5475 ) all_functions_sorted
5477 and generate_structs_pod () =
5478 (* Structs documentation. *)
5481 pr "=head2 guestfs_%s\n" typ;
5483 pr " struct guestfs_%s {\n" typ;
5486 | name, FChar -> pr " char %s;\n" name
5487 | name, FUInt32 -> pr " uint32_t %s;\n" name
5488 | name, FInt32 -> pr " int32_t %s;\n" name
5489 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5490 | name, FInt64 -> pr " int64_t %s;\n" name
5491 | name, FString -> pr " char *%s;\n" name
5493 pr " /* The next two fields describe a byte array. */\n";
5494 pr " uint32_t %s_len;\n" name;
5495 pr " char *%s;\n" name
5497 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5498 pr " char %s[32];\n" name
5499 | name, FOptPercent ->
5500 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5501 pr " float %s;\n" name
5505 pr " struct guestfs_%s_list {\n" typ;
5506 pr " uint32_t len; /* Number of elements in list. */\n";
5507 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5510 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5511 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5516 and generate_availability_pod () =
5517 (* Availability documentation. *)
5521 fun (group, functions) ->
5522 pr "=item B<%s>\n" group;
5524 pr "The following functions:\n";
5525 List.iter (pr "L</guestfs_%s>\n") functions;
5531 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5532 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5534 * We have to use an underscore instead of a dash because otherwise
5535 * rpcgen generates incorrect code.
5537 * This header is NOT exported to clients, but see also generate_structs_h.
5539 and generate_xdr () =
5540 generate_header CStyle LGPLv2plus;
5542 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5543 pr "typedef string str<>;\n";
5546 (* Internal structures. *)
5550 pr "struct guestfs_int_%s {\n" typ;
5552 | name, FChar -> pr " char %s;\n" name
5553 | name, FString -> pr " string %s<>;\n" name
5554 | name, FBuffer -> pr " opaque %s<>;\n" name
5555 | name, FUUID -> pr " opaque %s[32];\n" name
5556 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5557 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5558 | name, FOptPercent -> pr " float %s;\n" name
5562 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5567 fun (shortname, style, _, _, _, _, _) ->
5568 let name = "guestfs_" ^ shortname in
5570 (match snd style with
5573 pr "struct %s_args {\n" name;
5576 | Pathname n | Device n | Dev_or_Path n | String n ->
5577 pr " string %s<>;\n" n
5578 | OptString n -> pr " str *%s;\n" n
5579 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5580 | Bool n -> pr " bool %s;\n" n
5581 | Int n -> pr " int %s;\n" n
5582 | Int64 n -> pr " hyper %s;\n" n
5584 pr " opaque %s<>;\n" n
5585 | FileIn _ | FileOut _ -> ()
5589 (match fst style with
5592 pr "struct %s_ret {\n" name;
5596 pr "struct %s_ret {\n" name;
5597 pr " hyper %s;\n" n;
5600 pr "struct %s_ret {\n" name;
5603 | RConstString _ | RConstOptString _ ->
5604 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5606 pr "struct %s_ret {\n" name;
5607 pr " string %s<>;\n" n;
5610 pr "struct %s_ret {\n" name;
5611 pr " str %s<>;\n" n;
5613 | RStruct (n, typ) ->
5614 pr "struct %s_ret {\n" name;
5615 pr " guestfs_int_%s %s;\n" typ n;
5617 | RStructList (n, typ) ->
5618 pr "struct %s_ret {\n" name;
5619 pr " guestfs_int_%s_list %s;\n" typ n;
5622 pr "struct %s_ret {\n" name;
5623 pr " str %s<>;\n" n;
5626 pr "struct %s_ret {\n" name;
5627 pr " opaque %s<>;\n" n;
5632 (* Table of procedure numbers. *)
5633 pr "enum guestfs_procedure {\n";
5635 fun (shortname, _, proc_nr, _, _, _, _) ->
5636 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5638 pr " GUESTFS_PROC_NR_PROCS\n";
5642 (* Having to choose a maximum message size is annoying for several
5643 * reasons (it limits what we can do in the API), but it (a) makes
5644 * the protocol a lot simpler, and (b) provides a bound on the size
5645 * of the daemon which operates in limited memory space.
5647 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5650 (* Message header, etc. *)
5652 /* The communication protocol is now documented in the guestfs(3)
5656 const GUESTFS_PROGRAM = 0x2000F5F5;
5657 const GUESTFS_PROTOCOL_VERSION = 1;
5659 /* These constants must be larger than any possible message length. */
5660 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5661 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5663 enum guestfs_message_direction {
5664 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5665 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5668 enum guestfs_message_status {
5669 GUESTFS_STATUS_OK = 0,
5670 GUESTFS_STATUS_ERROR = 1
5673 const GUESTFS_ERROR_LEN = 256;
5675 struct guestfs_message_error {
5676 string error_message<GUESTFS_ERROR_LEN>;
5679 struct guestfs_message_header {
5680 unsigned prog; /* GUESTFS_PROGRAM */
5681 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5682 guestfs_procedure proc; /* GUESTFS_PROC_x */
5683 guestfs_message_direction direction;
5684 unsigned serial; /* message serial number */
5685 guestfs_message_status status;
5688 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5690 struct guestfs_chunk {
5691 int cancel; /* if non-zero, transfer is cancelled */
5692 /* data size is 0 bytes if the transfer has finished successfully */
5693 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5697 (* Generate the guestfs-structs.h file. *)
5698 and generate_structs_h () =
5699 generate_header CStyle LGPLv2plus;
5701 (* This is a public exported header file containing various
5702 * structures. The structures are carefully written to have
5703 * exactly the same in-memory format as the XDR structures that
5704 * we use on the wire to the daemon. The reason for creating
5705 * copies of these structures here is just so we don't have to
5706 * export the whole of guestfs_protocol.h (which includes much
5707 * unrelated and XDR-dependent stuff that we don't want to be
5708 * public, or required by clients).
5710 * To reiterate, we will pass these structures to and from the
5711 * client with a simple assignment or memcpy, so the format
5712 * must be identical to what rpcgen / the RFC defines.
5715 (* Public structures. *)
5718 pr "struct guestfs_%s {\n" typ;
5721 | name, FChar -> pr " char %s;\n" name
5722 | name, FString -> pr " char *%s;\n" name
5724 pr " uint32_t %s_len;\n" name;
5725 pr " char *%s;\n" name
5726 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5727 | name, FUInt32 -> pr " uint32_t %s;\n" name
5728 | name, FInt32 -> pr " int32_t %s;\n" name
5729 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5730 | name, FInt64 -> pr " int64_t %s;\n" name
5731 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5735 pr "struct guestfs_%s_list {\n" typ;
5736 pr " uint32_t len;\n";
5737 pr " struct guestfs_%s *val;\n" typ;
5740 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5741 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5745 (* Generate the guestfs-actions.h file. *)
5746 and generate_actions_h () =
5747 generate_header CStyle LGPLv2plus;
5749 fun (shortname, style, _, _, _, _, _) ->
5750 let name = "guestfs_" ^ shortname in
5751 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5755 (* Generate the guestfs-internal-actions.h file. *)
5756 and generate_internal_actions_h () =
5757 generate_header CStyle LGPLv2plus;
5759 fun (shortname, style, _, _, _, _, _) ->
5760 let name = "guestfs__" ^ shortname in
5761 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5763 ) non_daemon_functions
5765 (* Generate the client-side dispatch stubs. *)
5766 and generate_client_actions () =
5767 generate_header CStyle LGPLv2plus;
5774 #include <inttypes.h>
5776 #include \"guestfs.h\"
5777 #include \"guestfs-internal.h\"
5778 #include \"guestfs-internal-actions.h\"
5779 #include \"guestfs_protocol.h\"
5781 #define error guestfs_error
5782 //#define perrorf guestfs_perrorf
5783 #define safe_malloc guestfs_safe_malloc
5784 #define safe_realloc guestfs_safe_realloc
5785 //#define safe_strdup guestfs_safe_strdup
5786 #define safe_memdup guestfs_safe_memdup
5788 /* Check the return message from a call for validity. */
5790 check_reply_header (guestfs_h *g,
5791 const struct guestfs_message_header *hdr,
5792 unsigned int proc_nr, unsigned int serial)
5794 if (hdr->prog != GUESTFS_PROGRAM) {
5795 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5798 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5799 error (g, \"wrong protocol version (%%d/%%d)\",
5800 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5803 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5804 error (g, \"unexpected message direction (%%d/%%d)\",
5805 hdr->direction, GUESTFS_DIRECTION_REPLY);
5808 if (hdr->proc != proc_nr) {
5809 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5812 if (hdr->serial != serial) {
5813 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5820 /* Check we are in the right state to run a high-level action. */
5822 check_state (guestfs_h *g, const char *caller)
5824 if (!guestfs__is_ready (g)) {
5825 if (guestfs__is_config (g) || guestfs__is_launching (g))
5826 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5829 error (g, \"%%s called from the wrong state, %%d != READY\",
5830 caller, guestfs__get_state (g));
5838 (* Generate code to generate guestfish call traces. *)
5839 let trace_call shortname style =
5840 pr " if (guestfs__get_trace (g)) {\n";
5843 List.exists (function
5844 | StringList _ | DeviceList _ -> true
5845 | _ -> false) (snd style) in
5851 pr " printf (\"%s\");\n" shortname;
5854 | String n (* strings *)
5861 (* guestfish doesn't support string escaping, so neither do we *)
5862 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5863 | OptString n -> (* string option *)
5864 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5865 pr " else printf (\" null\");\n"
5867 | DeviceList n -> (* string list *)
5868 pr " putchar (' ');\n";
5869 pr " putchar ('\"');\n";
5870 pr " for (i = 0; %s[i]; ++i) {\n" n;
5871 pr " if (i > 0) putchar (' ');\n";
5872 pr " fputs (%s[i], stdout);\n" n;
5874 pr " putchar ('\"');\n";
5875 | Bool n -> (* boolean *)
5876 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5877 | Int n -> (* int *)
5878 pr " printf (\" %%d\", %s);\n" n
5880 pr " printf (\" %%\" PRIi64, %s);\n" n
5882 pr " putchar ('\\n');\n";
5887 (* For non-daemon functions, generate a wrapper around each function. *)
5889 fun (shortname, style, _, _, _, _, _) ->
5890 let name = "guestfs_" ^ shortname in
5892 generate_prototype ~extern:false ~semicolon:false ~newline:true
5893 ~handle:"g" name style;
5895 trace_call shortname style;
5896 pr " return guestfs__%s " shortname;
5897 generate_c_call_args ~handle:"g" style;
5901 ) non_daemon_functions;
5903 (* Client-side stubs for each function. *)
5905 fun (shortname, style, _, _, _, _, _) ->
5906 let name = "guestfs_" ^ shortname in
5908 (* Generate the action stub. *)
5909 generate_prototype ~extern:false ~semicolon:false ~newline:true
5910 ~handle:"g" name style;
5913 match fst style with
5914 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5915 | RConstString _ | RConstOptString _ ->
5916 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5917 | RString _ | RStringList _
5918 | RStruct _ | RStructList _
5919 | RHashtable _ | RBufferOut _ ->
5924 (match snd style with
5926 | _ -> pr " struct %s_args args;\n" name
5929 pr " guestfs_message_header hdr;\n";
5930 pr " guestfs_message_error err;\n";
5932 match fst style with
5934 | RConstString _ | RConstOptString _ ->
5935 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5937 | RBool _ | RString _ | RStringList _
5938 | RStruct _ | RStructList _
5939 | RHashtable _ | RBufferOut _ ->
5940 pr " struct %s_ret ret;\n" name;
5943 pr " int serial;\n";
5946 trace_call shortname style;
5947 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
5948 shortname error_code;
5949 pr " guestfs___set_busy (g);\n";
5952 (* Send the main header and arguments. *)
5953 (match snd style with
5955 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
5956 (String.uppercase shortname)
5960 | Pathname n | Device n | Dev_or_Path n | String n ->
5961 pr " args.%s = (char *) %s;\n" n n
5963 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
5964 | StringList n | DeviceList n ->
5965 pr " args.%s.%s_val = (char **) %s;\n" n n n;
5966 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
5968 pr " args.%s = %s;\n" n n
5970 pr " args.%s = %s;\n" n n
5972 pr " args.%s = %s;\n" n n
5973 | FileIn _ | FileOut _ -> ()
5975 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
5976 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
5977 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
5979 pr " guestfs___end_busy (g);\n";
5980 pr " return %s;\n" error_code;
5982 pr " args.%s.%s_val = (char *) %s;\n" n n n;
5983 pr " args.%s.%s_len = %s_size;\n" n n n
5985 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
5986 (String.uppercase shortname);
5987 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
5990 pr " if (serial == -1) {\n";
5991 pr " guestfs___end_busy (g);\n";
5992 pr " return %s;\n" error_code;
5996 (* Send any additional files (FileIn) requested. *)
5997 let need_read_reply_label = ref false in
6001 pr " r = guestfs___send_file (g, %s);\n" n;
6002 pr " if (r == -1) {\n";
6003 pr " guestfs___end_busy (g);\n";
6004 pr " return %s;\n" error_code;
6006 pr " if (r == -2) /* daemon cancelled */\n";
6007 pr " goto read_reply;\n";
6008 need_read_reply_label := true;
6013 (* Wait for the reply from the remote end. *)
6014 if !need_read_reply_label then pr " read_reply:\n";
6015 pr " memset (&hdr, 0, sizeof hdr);\n";
6016 pr " memset (&err, 0, sizeof err);\n";
6017 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6019 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6023 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6026 pr " if (r == -1) {\n";
6027 pr " guestfs___end_busy (g);\n";
6028 pr " return %s;\n" error_code;
6032 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6033 (String.uppercase shortname);
6034 pr " guestfs___end_busy (g);\n";
6035 pr " return %s;\n" error_code;
6039 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6040 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6041 pr " free (err.error_message);\n";
6042 pr " guestfs___end_busy (g);\n";
6043 pr " return %s;\n" error_code;
6047 (* Expecting to receive further files (FileOut)? *)
6051 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6052 pr " guestfs___end_busy (g);\n";
6053 pr " return %s;\n" error_code;
6059 pr " guestfs___end_busy (g);\n";
6061 (match fst style with
6062 | RErr -> pr " return 0;\n"
6063 | RInt n | RInt64 n | RBool n ->
6064 pr " return ret.%s;\n" n
6065 | RConstString _ | RConstOptString _ ->
6066 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6068 pr " return ret.%s; /* caller will free */\n" n
6069 | RStringList n | RHashtable n ->
6070 pr " /* caller will free this, but we need to add a NULL entry */\n";
6071 pr " ret.%s.%s_val =\n" n n;
6072 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6073 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6075 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6076 pr " return ret.%s.%s_val;\n" n n
6078 pr " /* caller will free this */\n";
6079 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6080 | RStructList (n, _) ->
6081 pr " /* caller will free this */\n";
6082 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6084 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6085 pr " * _val might be NULL here. To make the API saner for\n";
6086 pr " * callers, we turn this case into a unique pointer (using\n";
6087 pr " * malloc(1)).\n";
6089 pr " if (ret.%s.%s_len > 0) {\n" n n;
6090 pr " *size_r = ret.%s.%s_len;\n" n n;
6091 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6093 pr " free (ret.%s.%s_val);\n" n n;
6094 pr " char *p = safe_malloc (g, 1);\n";
6095 pr " *size_r = ret.%s.%s_len;\n" n n;
6103 (* Functions to free structures. *)
6104 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6105 pr " * structure format is identical to the XDR format. See note in\n";
6106 pr " * generator.ml.\n";
6113 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6115 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6121 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6123 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6130 (* Generate daemon/actions.h. *)
6131 and generate_daemon_actions_h () =
6132 generate_header CStyle GPLv2plus;
6134 pr "#include \"../src/guestfs_protocol.h\"\n";
6138 fun (name, style, _, _, _, _, _) ->
6140 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6144 (* Generate the linker script which controls the visibility of
6145 * symbols in the public ABI and ensures no other symbols get
6146 * exported accidentally.
6148 and generate_linker_script () =
6149 generate_header HashStyle GPLv2plus;
6154 "guestfs_get_error_handler";
6155 "guestfs_get_out_of_memory_handler";
6156 "guestfs_last_error";
6157 "guestfs_set_error_handler";
6158 "guestfs_set_launch_done_callback";
6159 "guestfs_set_log_message_callback";
6160 "guestfs_set_out_of_memory_handler";
6161 "guestfs_set_subprocess_quit_callback";
6163 (* Unofficial parts of the API: the bindings code use these
6164 * functions, so it is useful to export them.
6166 "guestfs_safe_calloc";
6167 "guestfs_safe_malloc";
6170 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6174 List.map (fun (typ, _) ->
6175 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6178 let globals = List.sort compare (globals @ functions @ structs) in
6182 List.iter (pr " %s;\n") globals;
6189 (* Generate the server-side stubs. *)
6190 and generate_daemon_actions () =
6191 generate_header CStyle GPLv2plus;
6193 pr "#include <config.h>\n";
6195 pr "#include <stdio.h>\n";
6196 pr "#include <stdlib.h>\n";
6197 pr "#include <string.h>\n";
6198 pr "#include <inttypes.h>\n";
6199 pr "#include <rpc/types.h>\n";
6200 pr "#include <rpc/xdr.h>\n";
6202 pr "#include \"daemon.h\"\n";
6203 pr "#include \"c-ctype.h\"\n";
6204 pr "#include \"../src/guestfs_protocol.h\"\n";
6205 pr "#include \"actions.h\"\n";
6209 fun (name, style, _, _, _, _, _) ->
6210 (* Generate server-side stubs. *)
6211 pr "static void %s_stub (XDR *xdr_in)\n" name;
6214 match fst style with
6215 | RErr | RInt _ -> pr " int r;\n"; "-1"
6216 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6217 | RBool _ -> pr " int r;\n"; "-1"
6218 | RConstString _ | RConstOptString _ ->
6219 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6220 | RString _ -> pr " char *r;\n"; "NULL"
6221 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6222 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6223 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6225 pr " size_t size = 1;\n";
6229 (match snd style with
6232 pr " struct guestfs_%s_args args;\n" name;
6235 | Device n | Dev_or_Path n
6238 | OptString n -> pr " char *%s;\n" n
6239 | StringList n | DeviceList n -> pr " char **%s;\n" n
6240 | Bool n -> pr " int %s;\n" n
6241 | Int n -> pr " int %s;\n" n
6242 | Int64 n -> pr " int64_t %s;\n" n
6243 | FileIn _ | FileOut _ -> ()
6245 pr " const char *%s;\n" n;
6246 pr " size_t %s_size;\n" n
6252 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6254 (match snd style with
6257 pr " memset (&args, 0, sizeof args);\n";
6259 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6261 pr " if (cancel_receive () != -2)\n";
6262 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6266 pr " char *%s = args.%s;\n" n n
6268 let pr_list_handling_code n =
6269 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6270 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6271 pr " if (%s == NULL) {\n" n;
6273 pr " if (cancel_receive () != -2)\n";
6274 pr " reply_with_perror (\"realloc\");\n";
6277 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6278 pr " args.%s.%s_val = %s;\n" n n n;
6284 pr " ABS_PATH (%s, %s, goto done);\n"
6285 n (if is_filein then "cancel_receive ()" else "0");
6288 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6289 n (if is_filein then "cancel_receive ()" else "0");
6292 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6293 n (if is_filein then "cancel_receive ()" else "0");
6294 | String n -> pr_args n
6295 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6297 pr_list_handling_code n;
6299 pr_list_handling_code n;
6300 pr " /* Ensure that each is a device,\n";
6301 pr " * and perform device name translation. */\n";
6302 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6303 pr " RESOLVE_DEVICE (physvols[pvi], %s, goto done);\n"
6304 (if is_filein then "cancel_receive ()" else "0");
6306 | Bool n -> pr " %s = args.%s;\n" n n
6307 | Int n -> pr " %s = args.%s;\n" n n
6308 | Int64 n -> pr " %s = args.%s;\n" n n
6309 | FileIn _ | FileOut _ -> ()
6311 pr " %s = args.%s.%s_val;\n" n n n;
6312 pr " %s_size = args.%s.%s_len;\n" n n n
6317 (* this is used at least for do_equal *)
6318 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6319 (* Emit NEED_ROOT just once, even when there are two or
6320 more Pathname args *)
6321 pr " NEED_ROOT (%s, goto done);\n"
6322 (if is_filein then "cancel_receive ()" else "0");
6325 (* Don't want to call the impl with any FileIn or FileOut
6326 * parameters, since these go "outside" the RPC protocol.
6329 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6331 pr " r = do_%s " name;
6332 generate_c_call_args (fst style, args');
6335 (match fst style with
6336 | RErr | RInt _ | RInt64 _ | RBool _
6337 | RConstString _ | RConstOptString _
6338 | RString _ | RStringList _ | RHashtable _
6339 | RStruct (_, _) | RStructList (_, _) ->
6340 pr " if (r == %s)\n" error_code;
6341 pr " /* do_%s has already called reply_with_error */\n" name;
6345 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6346 pr " * an ordinary zero-length buffer), so be careful ...\n";
6348 pr " if (size == 1 && r == %s)\n" error_code;
6349 pr " /* do_%s has already called reply_with_error */\n" name;
6354 (* If there are any FileOut parameters, then the impl must
6355 * send its own reply.
6358 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6360 pr " /* do_%s has already sent a reply */\n" name
6362 match fst style with
6363 | RErr -> pr " reply (NULL, NULL);\n"
6364 | RInt n | RInt64 n | RBool n ->
6365 pr " struct guestfs_%s_ret ret;\n" name;
6366 pr " ret.%s = r;\n" n;
6367 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6369 | RConstString _ | RConstOptString _ ->
6370 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6372 pr " struct guestfs_%s_ret ret;\n" name;
6373 pr " ret.%s = r;\n" n;
6374 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6377 | RStringList n | RHashtable n ->
6378 pr " struct guestfs_%s_ret ret;\n" name;
6379 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6380 pr " ret.%s.%s_val = r;\n" n n;
6381 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6383 pr " free_strings (r);\n"
6385 pr " struct guestfs_%s_ret ret;\n" name;
6386 pr " ret.%s = *r;\n" n;
6387 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6389 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6391 | RStructList (n, _) ->
6392 pr " struct guestfs_%s_ret ret;\n" name;
6393 pr " ret.%s = *r;\n" n;
6394 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6396 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6399 pr " struct guestfs_%s_ret ret;\n" name;
6400 pr " ret.%s.%s_val = r;\n" n n;
6401 pr " ret.%s.%s_len = size;\n" n n;
6402 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6407 (* Free the args. *)
6409 (match snd style with
6412 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6419 (* Dispatch function. *)
6420 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6422 pr " switch (proc_nr) {\n";
6425 fun (name, style, _, _, _, _, _) ->
6426 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6427 pr " %s_stub (xdr_in);\n" name;
6432 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";
6437 (* LVM columns and tokenization functions. *)
6438 (* XXX This generates crap code. We should rethink how we
6444 pr "static const char *lvm_%s_cols = \"%s\";\n"
6445 typ (String.concat "," (List.map fst cols));
6448 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6450 pr " char *tok, *p, *next;\n";
6454 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6457 pr " if (!str) {\n";
6458 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6461 pr " if (!*str || c_isspace (*str)) {\n";
6462 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6467 fun (name, coltype) ->
6468 pr " if (!tok) {\n";
6469 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6472 pr " p = strchrnul (tok, ',');\n";
6473 pr " if (*p) next = p+1; else next = NULL;\n";
6474 pr " *p = '\\0';\n";
6477 pr " r->%s = strdup (tok);\n" name;
6478 pr " if (r->%s == NULL) {\n" name;
6479 pr " perror (\"strdup\");\n";
6483 pr " for (i = j = 0; i < 32; ++j) {\n";
6484 pr " if (tok[j] == '\\0') {\n";
6485 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6487 pr " } else if (tok[j] != '-')\n";
6488 pr " r->%s[i++] = tok[j];\n" name;
6491 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6492 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6496 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6497 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6501 pr " if (tok[0] == '\\0')\n";
6502 pr " r->%s = -1;\n" name;
6503 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6504 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6507 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6508 assert false (* can never be an LVM column *)
6510 pr " tok = next;\n";
6513 pr " if (tok != NULL) {\n";
6514 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6521 pr "guestfs_int_lvm_%s_list *\n" typ;
6522 pr "parse_command_line_%ss (void)\n" typ;
6524 pr " char *out, *err;\n";
6525 pr " char *p, *pend;\n";
6527 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6528 pr " void *newp;\n";
6530 pr " ret = malloc (sizeof *ret);\n";
6531 pr " if (!ret) {\n";
6532 pr " reply_with_perror (\"malloc\");\n";
6533 pr " return NULL;\n";
6536 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6537 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6539 pr " r = command (&out, &err,\n";
6540 pr " \"lvm\", \"%ss\",\n" typ;
6541 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6542 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6543 pr " if (r == -1) {\n";
6544 pr " reply_with_error (\"%%s\", err);\n";
6545 pr " free (out);\n";
6546 pr " free (err);\n";
6547 pr " free (ret);\n";
6548 pr " return NULL;\n";
6551 pr " free (err);\n";
6553 pr " /* Tokenize each line of the output. */\n";
6556 pr " while (p) {\n";
6557 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6558 pr " if (pend) {\n";
6559 pr " *pend = '\\0';\n";
6563 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6566 pr " if (!*p) { /* Empty line? Skip it. */\n";
6571 pr " /* Allocate some space to store this next entry. */\n";
6572 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6573 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6574 pr " if (newp == NULL) {\n";
6575 pr " reply_with_perror (\"realloc\");\n";
6576 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6577 pr " free (ret);\n";
6578 pr " free (out);\n";
6579 pr " return NULL;\n";
6581 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6583 pr " /* Tokenize the next entry. */\n";
6584 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6585 pr " if (r == -1) {\n";
6586 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6587 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6588 pr " free (ret);\n";
6589 pr " free (out);\n";
6590 pr " return NULL;\n";
6597 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6599 pr " free (out);\n";
6600 pr " return ret;\n";
6603 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6605 (* Generate a list of function names, for debugging in the daemon.. *)
6606 and generate_daemon_names () =
6607 generate_header CStyle GPLv2plus;
6609 pr "#include <config.h>\n";
6611 pr "#include \"daemon.h\"\n";
6614 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6615 pr "const char *function_names[] = {\n";
6617 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6621 (* Generate the optional groups for the daemon to implement
6622 * guestfs_available.
6624 and generate_daemon_optgroups_c () =
6625 generate_header CStyle GPLv2plus;
6627 pr "#include <config.h>\n";
6629 pr "#include \"daemon.h\"\n";
6630 pr "#include \"optgroups.h\"\n";
6633 pr "struct optgroup optgroups[] = {\n";
6636 pr " { \"%s\", optgroup_%s_available },\n" group group
6638 pr " { NULL, NULL }\n";
6641 and generate_daemon_optgroups_h () =
6642 generate_header CStyle GPLv2plus;
6646 pr "extern int optgroup_%s_available (void);\n" group
6649 (* Generate the tests. *)
6650 and generate_tests () =
6651 generate_header CStyle GPLv2plus;
6658 #include <sys/types.h>
6661 #include \"guestfs.h\"
6662 #include \"guestfs-internal.h\"
6664 static guestfs_h *g;
6665 static int suppress_error = 0;
6667 static void print_error (guestfs_h *g, void *data, const char *msg)
6669 if (!suppress_error)
6670 fprintf (stderr, \"%%s\\n\", msg);
6673 /* FIXME: nearly identical code appears in fish.c */
6674 static void print_strings (char *const *argv)
6678 for (argc = 0; argv[argc] != NULL; ++argc)
6679 printf (\"\\t%%s\\n\", argv[argc]);
6683 static void print_table (char const *const *argv)
6687 for (i = 0; argv[i] != NULL; i += 2)
6688 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6694 (* Generate a list of commands which are not tested anywhere. *)
6695 pr "static void no_test_warnings (void)\n";
6698 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6700 fun (_, _, _, _, tests, _, _) ->
6701 let tests = filter_map (
6703 | (_, (Always|If _|Unless _), test) -> Some test
6704 | (_, Disabled, _) -> None
6706 let seq = List.concat (List.map seq_of_test tests) in
6707 let cmds_tested = List.map List.hd seq in
6708 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6712 fun (name, _, _, _, _, _, _) ->
6713 if not (Hashtbl.mem hash name) then
6714 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6720 (* Generate the actual tests. Note that we generate the tests
6721 * in reverse order, deliberately, so that (in general) the
6722 * newest tests run first. This makes it quicker and easier to
6727 fun (name, _, _, flags, tests, _, _) ->
6728 mapi (generate_one_test name flags) tests
6729 ) (List.rev all_functions) in
6730 let test_names = List.concat test_names in
6731 let nr_tests = List.length test_names in
6734 int main (int argc, char *argv[])
6737 unsigned long int n_failed = 0;
6738 const char *filename;
6740 int nr_tests, test_num = 0;
6742 setbuf (stdout, NULL);
6744 no_test_warnings ();
6746 g = guestfs_create ();
6748 printf (\"guestfs_create FAILED\\n\");
6749 exit (EXIT_FAILURE);
6752 guestfs_set_error_handler (g, print_error, NULL);
6754 guestfs_set_path (g, \"../appliance\");
6756 filename = \"test1.img\";
6757 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6760 exit (EXIT_FAILURE);
6762 if (lseek (fd, %d, SEEK_SET) == -1) {
6766 exit (EXIT_FAILURE);
6768 if (write (fd, &c, 1) == -1) {
6772 exit (EXIT_FAILURE);
6774 if (close (fd) == -1) {
6777 exit (EXIT_FAILURE);
6779 if (guestfs_add_drive (g, filename) == -1) {
6780 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6781 exit (EXIT_FAILURE);
6784 filename = \"test2.img\";
6785 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6788 exit (EXIT_FAILURE);
6790 if (lseek (fd, %d, SEEK_SET) == -1) {
6794 exit (EXIT_FAILURE);
6796 if (write (fd, &c, 1) == -1) {
6800 exit (EXIT_FAILURE);
6802 if (close (fd) == -1) {
6805 exit (EXIT_FAILURE);
6807 if (guestfs_add_drive (g, filename) == -1) {
6808 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6809 exit (EXIT_FAILURE);
6812 filename = \"test3.img\";
6813 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6816 exit (EXIT_FAILURE);
6818 if (lseek (fd, %d, SEEK_SET) == -1) {
6822 exit (EXIT_FAILURE);
6824 if (write (fd, &c, 1) == -1) {
6828 exit (EXIT_FAILURE);
6830 if (close (fd) == -1) {
6833 exit (EXIT_FAILURE);
6835 if (guestfs_add_drive (g, filename) == -1) {
6836 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6837 exit (EXIT_FAILURE);
6840 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6841 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6842 exit (EXIT_FAILURE);
6845 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6848 if (guestfs_launch (g) == -1) {
6849 printf (\"guestfs_launch FAILED\\n\");
6850 exit (EXIT_FAILURE);
6853 /* Cancel previous alarm. */
6858 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6862 pr " test_num++;\n";
6863 pr " if (guestfs_get_verbose (g))\n";
6864 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
6865 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6866 pr " if (%s () == -1) {\n" test_name;
6867 pr " printf (\"%s FAILED\\n\");\n" test_name;
6868 pr " n_failed++;\n";
6873 pr " guestfs_close (g);\n";
6874 pr " unlink (\"test1.img\");\n";
6875 pr " unlink (\"test2.img\");\n";
6876 pr " unlink (\"test3.img\");\n";
6879 pr " if (n_failed > 0) {\n";
6880 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6881 pr " exit (EXIT_FAILURE);\n";
6885 pr " exit (EXIT_SUCCESS);\n";
6888 and generate_one_test name flags i (init, prereq, test) =
6889 let test_name = sprintf "test_%s_%d" name i in
6892 static int %s_skip (void)
6896 str = getenv (\"TEST_ONLY\");
6898 return strstr (str, \"%s\") == NULL;
6899 str = getenv (\"SKIP_%s\");
6900 if (str && STREQ (str, \"1\")) return 1;
6901 str = getenv (\"SKIP_TEST_%s\");
6902 if (str && STREQ (str, \"1\")) return 1;
6906 " test_name name (String.uppercase test_name) (String.uppercase name);
6909 | Disabled | Always -> ()
6910 | If code | Unless code ->
6911 pr "static int %s_prereq (void)\n" test_name;
6919 static int %s (void)
6922 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6926 " test_name test_name test_name;
6928 (* Optional functions should only be tested if the relevant
6929 * support is available in the daemon.
6935 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6937 pr " suppress_error = 1;\n";
6938 pr " r = guestfs_available (g, (char **) groups);\n";
6939 pr " suppress_error = 0;\n";
6940 pr " if (r == -1) {\n";
6941 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
6950 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
6952 pr " if (! %s_prereq ()) {\n" test_name;
6953 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6957 generate_one_test_body name i test_name init test;
6959 pr " if (%s_prereq ()) {\n" test_name;
6960 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
6964 generate_one_test_body name i test_name init test;
6966 generate_one_test_body name i test_name init test
6974 and generate_one_test_body name i test_name init test =
6976 | InitNone (* XXX at some point, InitNone and InitEmpty became
6977 * folded together as the same thing. Really we should
6978 * make InitNone do nothing at all, but the tests may
6979 * need to be checked to make sure this is OK.
6982 pr " /* InitNone|InitEmpty for %s */\n" test_name;
6983 List.iter (generate_test_command_call test_name)
6984 [["blockdev_setrw"; "/dev/sda"];
6988 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
6989 List.iter (generate_test_command_call test_name)
6990 [["blockdev_setrw"; "/dev/sda"];
6993 ["part_disk"; "/dev/sda"; "mbr"]]
6995 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
6996 List.iter (generate_test_command_call test_name)
6997 [["blockdev_setrw"; "/dev/sda"];
7000 ["part_disk"; "/dev/sda"; "mbr"];
7001 ["mkfs"; "ext2"; "/dev/sda1"];
7002 ["mount_options"; ""; "/dev/sda1"; "/"]]
7003 | InitBasicFSonLVM ->
7004 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7006 List.iter (generate_test_command_call test_name)
7007 [["blockdev_setrw"; "/dev/sda"];
7010 ["part_disk"; "/dev/sda"; "mbr"];
7011 ["pvcreate"; "/dev/sda1"];
7012 ["vgcreate"; "VG"; "/dev/sda1"];
7013 ["lvcreate"; "LV"; "VG"; "8"];
7014 ["mkfs"; "ext2"; "/dev/VG/LV"];
7015 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7017 pr " /* InitISOFS for %s */\n" test_name;
7018 List.iter (generate_test_command_call test_name)
7019 [["blockdev_setrw"; "/dev/sda"];
7022 ["mount_ro"; "/dev/sdd"; "/"]]
7025 let get_seq_last = function
7027 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7030 let seq = List.rev seq in
7031 List.rev (List.tl seq), List.hd seq
7036 pr " /* TestRun for %s (%d) */\n" name i;
7037 List.iter (generate_test_command_call test_name) seq
7038 | TestOutput (seq, expected) ->
7039 pr " /* TestOutput for %s (%d) */\n" name i;
7040 pr " const char *expected = \"%s\";\n" (c_quote expected);
7041 let seq, last = get_seq_last seq in
7043 pr " if (STRNEQ (r, expected)) {\n";
7044 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7048 List.iter (generate_test_command_call test_name) seq;
7049 generate_test_command_call ~test test_name last
7050 | TestOutputList (seq, expected) ->
7051 pr " /* TestOutputList for %s (%d) */\n" name i;
7052 let seq, last = get_seq_last seq in
7056 pr " if (!r[%d]) {\n" i;
7057 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7058 pr " print_strings (r);\n";
7062 pr " const char *expected = \"%s\";\n" (c_quote str);
7063 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7064 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7069 pr " if (r[%d] != NULL) {\n" (List.length expected);
7070 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7072 pr " print_strings (r);\n";
7076 List.iter (generate_test_command_call test_name) seq;
7077 generate_test_command_call ~test test_name last
7078 | TestOutputListOfDevices (seq, expected) ->
7079 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7080 let seq, last = get_seq_last seq in
7084 pr " if (!r[%d]) {\n" i;
7085 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7086 pr " print_strings (r);\n";
7090 pr " const char *expected = \"%s\";\n" (c_quote str);
7091 pr " r[%d][5] = 's';\n" i;
7092 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7093 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7098 pr " if (r[%d] != NULL) {\n" (List.length expected);
7099 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7101 pr " print_strings (r);\n";
7105 List.iter (generate_test_command_call test_name) seq;
7106 generate_test_command_call ~test test_name last
7107 | TestOutputInt (seq, expected) ->
7108 pr " /* TestOutputInt for %s (%d) */\n" name i;
7109 let seq, last = get_seq_last seq in
7111 pr " if (r != %d) {\n" expected;
7112 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7118 List.iter (generate_test_command_call test_name) seq;
7119 generate_test_command_call ~test test_name last
7120 | TestOutputIntOp (seq, op, expected) ->
7121 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7122 let seq, last = get_seq_last seq in
7124 pr " if (! (r %s %d)) {\n" op expected;
7125 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7126 test_name op expected;
7131 List.iter (generate_test_command_call test_name) seq;
7132 generate_test_command_call ~test test_name last
7133 | TestOutputTrue seq ->
7134 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7135 let seq, last = get_seq_last seq in
7138 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7143 List.iter (generate_test_command_call test_name) seq;
7144 generate_test_command_call ~test test_name last
7145 | TestOutputFalse seq ->
7146 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7147 let seq, last = get_seq_last seq in
7150 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7155 List.iter (generate_test_command_call test_name) seq;
7156 generate_test_command_call ~test test_name last
7157 | TestOutputLength (seq, expected) ->
7158 pr " /* TestOutputLength for %s (%d) */\n" name i;
7159 let seq, last = get_seq_last seq in
7162 pr " for (j = 0; j < %d; ++j)\n" expected;
7163 pr " if (r[j] == NULL) {\n";
7164 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7166 pr " print_strings (r);\n";
7169 pr " if (r[j] != NULL) {\n";
7170 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7172 pr " print_strings (r);\n";
7176 List.iter (generate_test_command_call test_name) seq;
7177 generate_test_command_call ~test test_name last
7178 | TestOutputBuffer (seq, expected) ->
7179 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7180 pr " const char *expected = \"%s\";\n" (c_quote expected);
7181 let seq, last = get_seq_last seq in
7182 let len = String.length expected in
7184 pr " if (size != %d) {\n" len;
7185 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7188 pr " if (STRNEQLEN (r, expected, size)) {\n";
7189 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7193 List.iter (generate_test_command_call test_name) seq;
7194 generate_test_command_call ~test test_name last
7195 | TestOutputStruct (seq, checks) ->
7196 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7197 let seq, last = get_seq_last seq in
7201 | CompareWithInt (field, expected) ->
7202 pr " if (r->%s != %d) {\n" field expected;
7203 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7204 test_name field expected;
7205 pr " (int) r->%s);\n" field;
7208 | CompareWithIntOp (field, op, expected) ->
7209 pr " if (!(r->%s %s %d)) {\n" field op expected;
7210 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7211 test_name field op expected;
7212 pr " (int) r->%s);\n" field;
7215 | CompareWithString (field, expected) ->
7216 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7217 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7218 test_name field expected;
7219 pr " r->%s);\n" field;
7222 | CompareFieldsIntEq (field1, field2) ->
7223 pr " if (r->%s != r->%s) {\n" field1 field2;
7224 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7225 test_name field1 field2;
7226 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7229 | CompareFieldsStrEq (field1, field2) ->
7230 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7231 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7232 test_name field1 field2;
7233 pr " r->%s, r->%s);\n" field1 field2;
7238 List.iter (generate_test_command_call test_name) seq;
7239 generate_test_command_call ~test test_name last
7240 | TestLastFail seq ->
7241 pr " /* TestLastFail for %s (%d) */\n" name i;
7242 let seq, last = get_seq_last seq in
7243 List.iter (generate_test_command_call test_name) seq;
7244 generate_test_command_call test_name ~expect_error:true last
7246 (* Generate the code to run a command, leaving the result in 'r'.
7247 * If you expect to get an error then you should set expect_error:true.
7249 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7251 | [] -> assert false
7253 (* Look up the command to find out what args/ret it has. *)
7256 let _, style, _, _, _, _, _ =
7257 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7260 failwithf "%s: in test, command %s was not found" test_name name in
7262 if List.length (snd style) <> List.length args then
7263 failwithf "%s: in test, wrong number of args given to %s"
7270 | OptString n, "NULL" -> ()
7273 | Dev_or_Path n, arg
7275 | OptString n, arg ->
7276 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7277 | BufferIn n, arg ->
7278 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7279 pr " size_t %s_size = %d;\n" n (String.length arg)
7283 | FileIn _, _ | FileOut _, _ -> ()
7284 | StringList n, "" | DeviceList n, "" ->
7285 pr " const char *const %s[1] = { NULL };\n" n
7286 | StringList n, arg | DeviceList n, arg ->
7287 let strs = string_split " " arg in
7290 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7292 pr " const char *const %s[] = {\n" n;
7294 fun i _ -> pr " %s_%d,\n" n i
7298 ) (List.combine (snd style) args);
7301 match fst style with
7302 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7303 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7304 | RConstString _ | RConstOptString _ ->
7305 pr " const char *r;\n"; "NULL"
7306 | RString _ -> pr " char *r;\n"; "NULL"
7307 | RStringList _ | RHashtable _ ->
7311 | RStruct (_, typ) ->
7312 pr " struct guestfs_%s *r;\n" typ; "NULL"
7313 | RStructList (_, typ) ->
7314 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7317 pr " size_t size;\n";
7320 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7321 pr " r = guestfs_%s (g" name;
7323 (* Generate the parameters. *)
7326 | OptString _, "NULL" -> pr ", NULL"
7328 | Device n, _ | Dev_or_Path n, _
7333 pr ", %s, %s_size" n n
7334 | FileIn _, arg | FileOut _, arg ->
7335 pr ", \"%s\"" (c_quote arg)
7336 | StringList n, _ | DeviceList n, _ ->
7337 pr ", (char **) %s" n
7340 try int_of_string arg
7341 with Failure "int_of_string" ->
7342 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7346 try Int64.of_string arg
7347 with Failure "int_of_string" ->
7348 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7351 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7352 ) (List.combine (snd style) args);
7354 (match fst style with
7355 | RBufferOut _ -> pr ", &size"
7361 if not expect_error then
7362 pr " if (r == %s)\n" error_code
7364 pr " if (r != %s)\n" error_code;
7367 (* Insert the test code. *)
7373 (match fst style with
7374 | RErr | RInt _ | RInt64 _ | RBool _
7375 | RConstString _ | RConstOptString _ -> ()
7376 | RString _ | RBufferOut _ -> pr " free (r);\n"
7377 | RStringList _ | RHashtable _ ->
7378 pr " for (i = 0; r[i] != NULL; ++i)\n";
7379 pr " free (r[i]);\n";
7381 | RStruct (_, typ) ->
7382 pr " guestfs_free_%s (r);\n" typ
7383 | RStructList (_, typ) ->
7384 pr " guestfs_free_%s_list (r);\n" typ
7390 let str = replace_str str "\r" "\\r" in
7391 let str = replace_str str "\n" "\\n" in
7392 let str = replace_str str "\t" "\\t" in
7393 let str = replace_str str "\000" "\\0" in
7396 (* Generate a lot of different functions for guestfish. *)
7397 and generate_fish_cmds () =
7398 generate_header CStyle GPLv2plus;
7402 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7404 let all_functions_sorted =
7406 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7407 ) all_functions_sorted in
7409 pr "#include <config.h>\n";
7411 pr "#include <stdio.h>\n";
7412 pr "#include <stdlib.h>\n";
7413 pr "#include <string.h>\n";
7414 pr "#include <inttypes.h>\n";
7416 pr "#include <guestfs.h>\n";
7417 pr "#include \"c-ctype.h\"\n";
7418 pr "#include \"full-write.h\"\n";
7419 pr "#include \"xstrtol.h\"\n";
7420 pr "#include \"fish.h\"\n";
7423 (* list_commands function, which implements guestfish -h *)
7424 pr "void list_commands (void)\n";
7426 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7427 pr " list_builtin_commands ();\n";
7429 fun (name, _, _, flags, _, shortdesc, _) ->
7430 let name = replace_char name '_' '-' in
7431 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7433 ) all_functions_sorted;
7434 pr " printf (\" %%s\\n\",";
7435 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7439 (* display_command function, which implements guestfish -h cmd *)
7440 pr "void display_command (const char *cmd)\n";
7443 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7444 let name2 = replace_char name '_' '-' in
7446 try find_map (function FishAlias n -> Some n | _ -> None) flags
7447 with Not_found -> name in
7448 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7450 match snd style with
7454 name2 (String.concat " " (List.map name_of_argt args)) in
7457 if List.mem ProtocolLimitWarning flags then
7458 ("\n\n" ^ protocol_limit_warning)
7461 (* For DangerWillRobinson commands, we should probably have
7462 * guestfish prompt before allowing you to use them (especially
7463 * in interactive mode). XXX
7467 if List.mem DangerWillRobinson flags then
7468 ("\n\n" ^ danger_will_robinson)
7473 match deprecation_notice flags with
7475 | Some txt -> "\n\n" ^ txt in
7477 let describe_alias =
7478 if name <> alias then
7479 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7483 pr "STRCASEEQ (cmd, \"%s\")" name;
7484 if name <> name2 then
7485 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7486 if name <> alias then
7487 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7489 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7491 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7492 "=head1 DESCRIPTION\n\n" ^
7493 longdesc ^ warnings ^ describe_alias);
7496 pr " display_builtin_command (cmd);\n";
7500 let emit_print_list_function typ =
7501 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7504 pr " unsigned int i;\n";
7506 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7507 pr " printf (\"[%%d] = {\\n\", i);\n";
7508 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7509 pr " printf (\"}\\n\");\n";
7515 (* print_* functions *)
7519 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7521 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7524 pr " unsigned int i;\n";
7530 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7532 pr " printf (\"%%s%s: \", indent);\n" name;
7533 pr " for (i = 0; i < 32; ++i)\n";
7534 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7535 pr " printf (\"\\n\");\n"
7537 pr " printf (\"%%s%s: \", indent);\n" name;
7538 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7539 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7540 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7542 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7543 pr " printf (\"\\n\");\n"
7544 | name, (FUInt64|FBytes) ->
7545 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7548 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7551 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7554 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7557 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7559 | name, FOptPercent ->
7560 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7561 typ name name typ name;
7562 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7568 (* Emit a print_TYPE_list function definition only if that function is used. *)
7571 | typ, (RStructListOnly | RStructAndList) ->
7572 (* generate the function for typ *)
7573 emit_print_list_function typ
7574 | typ, _ -> () (* empty *)
7575 ) (rstructs_used_by all_functions);
7577 (* Emit a print_TYPE function definition only if that function is used. *)
7580 | typ, (RStructOnly | RStructAndList) ->
7581 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7583 pr " print_%s_indent (%s, \"\");\n" typ typ;
7586 | typ, _ -> () (* empty *)
7587 ) (rstructs_used_by all_functions);
7589 (* run_<action> actions *)
7591 fun (name, style, _, flags, _, _, _) ->
7592 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7594 (match fst style with
7597 | RBool _ -> pr " int r;\n"
7598 | RInt64 _ -> pr " int64_t r;\n"
7599 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7600 | RString _ -> pr " char *r;\n"
7601 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7602 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7603 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7606 pr " size_t size;\n";
7612 | OptString n -> pr " const char *%s;\n" n
7616 | FileOut n -> pr " char *%s;\n" n
7618 pr " const char *%s;\n" n;
7619 pr " size_t %s_size;\n" n
7620 | StringList n | DeviceList n -> pr " char **%s;\n" n
7621 | Bool n -> pr " int %s;\n" n
7622 | Int n -> pr " int %s;\n" n
7623 | Int64 n -> pr " int64_t %s;\n" n
7626 (* Check and convert parameters. *)
7627 let argc_expected = List.length (snd style) in
7628 pr " if (argc != %d) {\n" argc_expected;
7629 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7631 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7635 let parse_integer fn fntyp rtyp range name i =
7637 pr " strtol_error xerr;\n";
7638 pr " %s r;\n" fntyp;
7640 pr " xerr = %s (argv[%d], NULL, 0, &r, \"\");\n" fn i;
7641 pr " if (xerr != LONGINT_OK) {\n";
7642 pr " fprintf (stderr,\n";
7643 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7644 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7649 | Some (min, max, comment) ->
7650 pr " /* %s */\n" comment;
7651 pr " if (r < %s || r > %s) {\n" min max;
7652 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7656 pr " /* The check above should ensure this assignment does not overflow. */\n";
7658 pr " %s = r;\n" name;
7667 pr " %s = argv[%d];\n" name i
7669 | Dev_or_Path name ->
7670 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7671 pr " if (%s == NULL) return -1;\n" name
7673 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7676 pr " %s = argv[%d];\n" name i;
7677 pr " %s_size = strlen (argv[%d]);\n" name i
7679 pr " %s = file_in (argv[%d]);\n" name i;
7680 pr " if (%s == NULL) return -1;\n" name
7682 pr " %s = file_out (argv[%d]);\n" name i;
7683 pr " if (%s == NULL) return -1;\n" name
7684 | StringList name | DeviceList name ->
7685 pr " %s = parse_string_list (argv[%d]);\n" name i;
7686 pr " if (%s == NULL) return -1;\n" name;
7688 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7691 let min = "(-(2LL<<30))"
7692 and max = "((2LL<<30)-1)"
7694 "The Int type in the generator is a signed 31 bit int." in
7695 Some (min, max, comment) in
7696 parse_integer "xstrtoll" "long long" "int" range name i
7698 parse_integer "xstrtoll" "long long" "int64_t" None name i
7701 (* Call C API function. *)
7702 pr " r = guestfs_%s " name;
7703 generate_c_call_args ~handle:"g" style;
7708 | Device name | String name
7709 | OptString name | Bool name
7710 | Int name | Int64 name
7711 | BufferIn name -> ()
7712 | Pathname name | Dev_or_Path name | FileOut name ->
7713 pr " free (%s);\n" name
7715 pr " free_file_in (%s);\n" name
7716 | StringList name | DeviceList name ->
7717 pr " free_strings (%s);\n" name
7720 (* Any output flags? *)
7722 let flags = filter_map (
7723 function FishOutput flag -> Some flag | _ -> None
7729 failwithf "%s: more than one FishOutput flag is not allowed" name in
7731 (* Check return value for errors and display command results. *)
7732 (match fst style with
7733 | RErr -> pr " return r;\n"
7735 pr " if (r == -1) return -1;\n";
7736 (match fish_output with
7738 pr " printf (\"%%d\\n\", r);\n";
7739 | Some FishOutputOctal ->
7740 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7741 | Some FishOutputHexadecimal ->
7742 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7745 pr " if (r == -1) return -1;\n";
7746 (match fish_output with
7748 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7749 | Some FishOutputOctal ->
7750 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7751 | Some FishOutputHexadecimal ->
7752 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7755 pr " if (r == -1) return -1;\n";
7756 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7759 pr " if (r == NULL) return -1;\n";
7760 pr " printf (\"%%s\\n\", r);\n";
7762 | RConstOptString _ ->
7763 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7766 pr " if (r == NULL) return -1;\n";
7767 pr " printf (\"%%s\\n\", r);\n";
7771 pr " if (r == NULL) return -1;\n";
7772 pr " print_strings (r);\n";
7773 pr " free_strings (r);\n";
7775 | RStruct (_, typ) ->
7776 pr " if (r == NULL) return -1;\n";
7777 pr " print_%s (r);\n" typ;
7778 pr " guestfs_free_%s (r);\n" typ;
7780 | RStructList (_, typ) ->
7781 pr " if (r == NULL) return -1;\n";
7782 pr " print_%s_list (r);\n" typ;
7783 pr " guestfs_free_%s_list (r);\n" typ;
7786 pr " if (r == NULL) return -1;\n";
7787 pr " print_table (r);\n";
7788 pr " free_strings (r);\n";
7791 pr " if (r == NULL) return -1;\n";
7792 pr " if (full_write (1, r, size) != size) {\n";
7793 pr " perror (\"write\");\n";
7804 (* run_action function *)
7805 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7808 fun (name, _, _, flags, _, _, _) ->
7809 let name2 = replace_char name '_' '-' in
7811 try find_map (function FishAlias n -> Some n | _ -> None) flags
7812 with Not_found -> name in
7814 pr "STRCASEEQ (cmd, \"%s\")" name;
7815 if name <> name2 then
7816 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7817 if name <> alias then
7818 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7820 pr " return run_%s (cmd, argc, argv);\n" name;
7824 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7825 pr " if (command_num == 1)\n";
7826 pr " extended_help_message ();\n";
7833 (* Readline completion for guestfish. *)
7834 and generate_fish_completion () =
7835 generate_header CStyle GPLv2plus;
7839 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7849 #ifdef HAVE_LIBREADLINE
7850 #include <readline/readline.h>
7855 #ifdef HAVE_LIBREADLINE
7857 static const char *const commands[] = {
7858 BUILTIN_COMMANDS_FOR_COMPLETION,
7861 (* Get the commands, including the aliases. They don't need to be
7862 * sorted - the generator() function just does a dumb linear search.
7866 fun (name, _, _, flags, _, _, _) ->
7867 let name2 = replace_char name '_' '-' in
7869 try find_map (function FishAlias n -> Some n | _ -> None) flags
7870 with Not_found -> name in
7872 if name <> alias then [name2; alias] else [name2]
7874 let commands = List.flatten commands in
7876 List.iter (pr " \"%s\",\n") commands;
7882 generator (const char *text, int state)
7884 static int index, len;
7889 len = strlen (text);
7892 rl_attempted_completion_over = 1;
7894 while ((name = commands[index]) != NULL) {
7896 if (STRCASEEQLEN (name, text, len))
7897 return strdup (name);
7903 #endif /* HAVE_LIBREADLINE */
7905 #ifdef HAVE_RL_COMPLETION_MATCHES
7906 #define RL_COMPLETION_MATCHES rl_completion_matches
7908 #ifdef HAVE_COMPLETION_MATCHES
7909 #define RL_COMPLETION_MATCHES completion_matches
7911 #endif /* else just fail if we don't have either symbol */
7914 do_completion (const char *text, int start, int end)
7916 char **matches = NULL;
7918 #ifdef HAVE_LIBREADLINE
7919 rl_completion_append_character = ' ';
7922 matches = RL_COMPLETION_MATCHES (text, generator);
7923 else if (complete_dest_paths)
7924 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
7931 (* Generate the POD documentation for guestfish. *)
7932 and generate_fish_actions_pod () =
7933 let all_functions_sorted =
7935 fun (_, _, _, flags, _, _, _) ->
7936 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7937 ) all_functions_sorted in
7939 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
7942 fun (name, style, _, flags, _, _, longdesc) ->
7944 Str.global_substitute rex (
7947 try Str.matched_group 1 s
7949 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
7950 "C<" ^ replace_char sub '_' '-' ^ ">"
7952 let name = replace_char name '_' '-' in
7954 try find_map (function FishAlias n -> Some n | _ -> None) flags
7955 with Not_found -> name in
7957 pr "=head2 %s" name;
7958 if name <> alias then
7965 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
7966 | OptString n -> pr " %s" n
7967 | StringList n | DeviceList n -> pr " '%s ...'" n
7968 | Bool _ -> pr " true|false"
7969 | Int n -> pr " %s" n
7970 | Int64 n -> pr " %s" n
7971 | FileIn n | FileOut n -> pr " (%s|-)" n
7972 | BufferIn n -> pr " %s" n
7976 pr "%s\n\n" longdesc;
7978 if List.exists (function FileIn _ | FileOut _ -> true
7979 | _ -> false) (snd style) then
7980 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
7982 if List.mem ProtocolLimitWarning flags then
7983 pr "%s\n\n" protocol_limit_warning;
7985 if List.mem DangerWillRobinson flags then
7986 pr "%s\n\n" danger_will_robinson;
7988 match deprecation_notice flags with
7990 | Some txt -> pr "%s\n\n" txt
7991 ) all_functions_sorted
7993 (* Generate a C function prototype. *)
7994 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
7995 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
7997 ?handle name style =
7998 if extern then pr "extern ";
7999 if static then pr "static ";
8000 (match fst style with
8002 | RInt _ -> pr "int "
8003 | RInt64 _ -> pr "int64_t "
8004 | RBool _ -> pr "int "
8005 | RConstString _ | RConstOptString _ -> pr "const char *"
8006 | RString _ | RBufferOut _ -> pr "char *"
8007 | RStringList _ | RHashtable _ -> pr "char **"
8008 | RStruct (_, typ) ->
8009 if not in_daemon then pr "struct guestfs_%s *" typ
8010 else pr "guestfs_int_%s *" typ
8011 | RStructList (_, typ) ->
8012 if not in_daemon then pr "struct guestfs_%s_list *" typ
8013 else pr "guestfs_int_%s_list *" typ
8015 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8016 pr "%s%s (" prefix name;
8017 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8020 let comma = ref false in
8023 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8027 if single_line then pr ", " else pr ",\n\t\t"
8034 | Device n | Dev_or_Path n
8038 pr "const char *%s" n
8039 | StringList n | DeviceList n ->
8041 pr "char *const *%s" n
8042 | Bool n -> next (); pr "int %s" n
8043 | Int n -> next (); pr "int %s" n
8044 | Int64 n -> next (); pr "int64_t %s" n
8047 if not in_daemon then (next (); pr "const char *%s" n)
8050 pr "const char *%s" n;
8052 pr "size_t %s_size" n
8054 if is_RBufferOut then (next (); pr "size_t *size_r");
8057 if semicolon then pr ";";
8058 if newline then pr "\n"
8060 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8061 and generate_c_call_args ?handle ?(decl = false) style =
8063 let comma = ref false in
8065 if !comma then pr ", ";
8070 | Some handle -> pr "%s" handle; comma := true
8076 pr "%s, %s_size" n n
8079 pr "%s" (name_of_argt arg)
8081 (* For RBufferOut calls, add implicit &size parameter. *)
8083 match fst style with
8091 (* Generate the OCaml bindings interface. *)
8092 and generate_ocaml_mli () =
8093 generate_header OCamlStyle LGPLv2plus;
8096 (** For API documentation you should refer to the C API
8097 in the guestfs(3) manual page. The OCaml API uses almost
8098 exactly the same calls. *)
8101 (** A [guestfs_h] handle. *)
8103 exception Error of string
8104 (** This exception is raised when there is an error. *)
8106 exception Handle_closed of string
8107 (** This exception is raised if you use a {!Guestfs.t} handle
8108 after calling {!close} on it. The string is the name of
8111 val create : unit -> t
8112 (** Create a {!Guestfs.t} handle. *)
8114 val close : t -> unit
8115 (** Close the {!Guestfs.t} handle and free up all resources used
8118 Handles are closed by the garbage collector when they become
8119 unreferenced, but callers can call this in order to provide
8120 predictable cleanup. *)
8123 generate_ocaml_structure_decls ();
8127 fun (name, style, _, _, _, shortdesc, _) ->
8128 generate_ocaml_prototype name style;
8129 pr "(** %s *)\n" shortdesc;
8131 ) all_functions_sorted
8133 (* Generate the OCaml bindings implementation. *)
8134 and generate_ocaml_ml () =
8135 generate_header OCamlStyle LGPLv2plus;
8140 exception Error of string
8141 exception Handle_closed of string
8143 external create : unit -> t = \"ocaml_guestfs_create\"
8144 external close : t -> unit = \"ocaml_guestfs_close\"
8146 (* Give the exceptions names, so they can be raised from the C code. *)
8148 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8149 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8153 generate_ocaml_structure_decls ();
8157 fun (name, style, _, _, _, shortdesc, _) ->
8158 generate_ocaml_prototype ~is_external:true name style;
8159 ) all_functions_sorted
8161 (* Generate the OCaml bindings C implementation. *)
8162 and generate_ocaml_c () =
8163 generate_header CStyle LGPLv2plus;
8170 #include <caml/config.h>
8171 #include <caml/alloc.h>
8172 #include <caml/callback.h>
8173 #include <caml/fail.h>
8174 #include <caml/memory.h>
8175 #include <caml/mlvalues.h>
8176 #include <caml/signals.h>
8178 #include <guestfs.h>
8180 #include \"guestfs_c.h\"
8182 /* Copy a hashtable of string pairs into an assoc-list. We return
8183 * the list in reverse order, but hashtables aren't supposed to be
8186 static CAMLprim value
8187 copy_table (char * const * argv)
8190 CAMLlocal5 (rv, pairv, kv, vv, cons);
8194 for (i = 0; argv[i] != NULL; i += 2) {
8195 kv = caml_copy_string (argv[i]);
8196 vv = caml_copy_string (argv[i+1]);
8197 pairv = caml_alloc (2, 0);
8198 Store_field (pairv, 0, kv);
8199 Store_field (pairv, 1, vv);
8200 cons = caml_alloc (2, 0);
8201 Store_field (cons, 1, rv);
8203 Store_field (cons, 0, pairv);
8211 (* Struct copy functions. *)
8213 let emit_ocaml_copy_list_function typ =
8214 pr "static CAMLprim value\n";
8215 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8217 pr " CAMLparam0 ();\n";
8218 pr " CAMLlocal2 (rv, v);\n";
8219 pr " unsigned int i;\n";
8221 pr " if (%ss->len == 0)\n" typ;
8222 pr " CAMLreturn (Atom (0));\n";
8224 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8225 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8226 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8227 pr " caml_modify (&Field (rv, i), v);\n";
8229 pr " CAMLreturn (rv);\n";
8237 let has_optpercent_col =
8238 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8240 pr "static CAMLprim value\n";
8241 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8243 pr " CAMLparam0 ();\n";
8244 if has_optpercent_col then
8245 pr " CAMLlocal3 (rv, v, v2);\n"
8247 pr " CAMLlocal2 (rv, v);\n";
8249 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8254 pr " v = caml_copy_string (%s->%s);\n" typ name
8256 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8257 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8260 pr " v = caml_alloc_string (32);\n";
8261 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8262 | name, (FBytes|FInt64|FUInt64) ->
8263 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8264 | name, (FInt32|FUInt32) ->
8265 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8266 | name, FOptPercent ->
8267 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8268 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8269 pr " v = caml_alloc (1, 0);\n";
8270 pr " Store_field (v, 0, v2);\n";
8271 pr " } else /* None */\n";
8272 pr " v = Val_int (0);\n";
8274 pr " v = Val_int (%s->%s);\n" typ name
8276 pr " Store_field (rv, %d, v);\n" i
8278 pr " CAMLreturn (rv);\n";
8283 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8286 | typ, (RStructListOnly | RStructAndList) ->
8287 (* generate the function for typ *)
8288 emit_ocaml_copy_list_function typ
8289 | typ, _ -> () (* empty *)
8290 ) (rstructs_used_by all_functions);
8294 fun (name, style, _, _, _, _, _) ->
8295 pr "/* Automatically generated wrapper for function\n";
8297 generate_ocaml_prototype name style;
8302 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8304 let needs_extra_vs =
8305 match fst style with RConstOptString _ -> true | _ -> false in
8307 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8308 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8309 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8312 pr "CAMLprim value\n";
8313 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8314 List.iter (pr ", value %s") (List.tl params);
8319 | [p1; p2; p3; p4; p5] ->
8320 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8321 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8322 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8323 pr " CAMLxparam%d (%s);\n"
8324 (List.length rest) (String.concat ", " rest)
8326 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8328 if not needs_extra_vs then
8329 pr " CAMLlocal1 (rv);\n"
8331 pr " CAMLlocal3 (rv, v, v2);\n";
8334 pr " guestfs_h *g = Guestfs_val (gv);\n";
8335 pr " if (g == NULL)\n";
8336 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8342 | Device n | Dev_or_Path n
8346 pr " const char *%s = String_val (%sv);\n" n n
8348 pr " const char *%s =\n" n;
8349 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8352 pr " const char *%s = String_val (%sv);\n" n n;
8353 pr " size_t %s_size = caml_string_length (%sv);\n" n n
8354 | StringList n | DeviceList n ->
8355 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8357 pr " int %s = Bool_val (%sv);\n" n n
8359 pr " int %s = Int_val (%sv);\n" n n
8361 pr " int64_t %s = Int64_val (%sv);\n" n n
8364 match fst style with
8365 | RErr -> pr " int r;\n"; "-1"
8366 | RInt _ -> pr " int r;\n"; "-1"
8367 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8368 | RBool _ -> pr " int r;\n"; "-1"
8369 | RConstString _ | RConstOptString _ ->
8370 pr " const char *r;\n"; "NULL"
8371 | RString _ -> pr " char *r;\n"; "NULL"
8376 | RStruct (_, typ) ->
8377 pr " struct guestfs_%s *r;\n" typ; "NULL"
8378 | RStructList (_, typ) ->
8379 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8386 pr " size_t size;\n";
8390 pr " caml_enter_blocking_section ();\n";
8391 pr " r = guestfs_%s " name;
8392 generate_c_call_args ~handle:"g" style;
8394 pr " caml_leave_blocking_section ();\n";
8398 | StringList n | DeviceList n ->
8399 pr " ocaml_guestfs_free_strings (%s);\n" n;
8400 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8401 | Bool _ | Int _ | Int64 _
8402 | FileIn _ | FileOut _ | BufferIn _ -> ()
8405 pr " if (r == %s)\n" error_code;
8406 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8409 (match fst style with
8410 | RErr -> pr " rv = Val_unit;\n"
8411 | RInt _ -> pr " rv = Val_int (r);\n"
8413 pr " rv = caml_copy_int64 (r);\n"
8414 | RBool _ -> pr " rv = Val_bool (r);\n"
8416 pr " rv = caml_copy_string (r);\n"
8417 | RConstOptString _ ->
8418 pr " if (r) { /* Some string */\n";
8419 pr " v = caml_alloc (1, 0);\n";
8420 pr " v2 = caml_copy_string (r);\n";
8421 pr " Store_field (v, 0, v2);\n";
8422 pr " } else /* None */\n";
8423 pr " v = Val_int (0);\n";
8425 pr " rv = caml_copy_string (r);\n";
8428 pr " rv = caml_copy_string_array ((const char **) r);\n";
8429 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8431 | RStruct (_, typ) ->
8432 pr " rv = copy_%s (r);\n" typ;
8433 pr " guestfs_free_%s (r);\n" typ;
8434 | RStructList (_, typ) ->
8435 pr " rv = copy_%s_list (r);\n" typ;
8436 pr " guestfs_free_%s_list (r);\n" typ;
8438 pr " rv = copy_table (r);\n";
8439 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8442 pr " rv = caml_alloc_string (size);\n";
8443 pr " memcpy (String_val (rv), r, size);\n";
8446 pr " CAMLreturn (rv);\n";
8450 if List.length params > 5 then (
8451 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8452 pr "CAMLprim value ";
8453 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8454 pr "CAMLprim value\n";
8455 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8457 pr " return ocaml_guestfs_%s (argv[0]" name;
8458 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8463 ) all_functions_sorted
8465 and generate_ocaml_structure_decls () =
8468 pr "type %s = {\n" typ;
8471 | name, FString -> pr " %s : string;\n" name
8472 | name, FBuffer -> pr " %s : string;\n" name
8473 | name, FUUID -> pr " %s : string;\n" name
8474 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8475 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8476 | name, FChar -> pr " %s : char;\n" name
8477 | name, FOptPercent -> pr " %s : float option;\n" name
8483 and generate_ocaml_prototype ?(is_external = false) name style =
8484 if is_external then pr "external " else pr "val ";
8485 pr "%s : t -> " name;
8488 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8489 | BufferIn _ -> pr "string -> "
8490 | OptString _ -> pr "string option -> "
8491 | StringList _ | DeviceList _ -> pr "string array -> "
8492 | Bool _ -> pr "bool -> "
8493 | Int _ -> pr "int -> "
8494 | Int64 _ -> pr "int64 -> "
8496 (match fst style with
8497 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8498 | RInt _ -> pr "int"
8499 | RInt64 _ -> pr "int64"
8500 | RBool _ -> pr "bool"
8501 | RConstString _ -> pr "string"
8502 | RConstOptString _ -> pr "string option"
8503 | RString _ | RBufferOut _ -> pr "string"
8504 | RStringList _ -> pr "string array"
8505 | RStruct (_, typ) -> pr "%s" typ
8506 | RStructList (_, typ) -> pr "%s array" typ
8507 | RHashtable _ -> pr "(string * string) list"
8509 if is_external then (
8511 if List.length (snd style) + 1 > 5 then
8512 pr "\"ocaml_guestfs_%s_byte\" " name;
8513 pr "\"ocaml_guestfs_%s\"" name
8517 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8518 and generate_perl_xs () =
8519 generate_header CStyle LGPLv2plus;
8522 #include \"EXTERN.h\"
8526 #include <guestfs.h>
8529 #define PRId64 \"lld\"
8533 my_newSVll(long long val) {
8534 #ifdef USE_64_BIT_ALL
8535 return newSViv(val);
8539 len = snprintf(buf, 100, \"%%\" PRId64, val);
8540 return newSVpv(buf, len);
8545 #define PRIu64 \"llu\"
8549 my_newSVull(unsigned long long val) {
8550 #ifdef USE_64_BIT_ALL
8551 return newSVuv(val);
8555 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8556 return newSVpv(buf, len);
8560 /* http://www.perlmonks.org/?node_id=680842 */
8562 XS_unpack_charPtrPtr (SV *arg) {
8567 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8568 croak (\"array reference expected\");
8570 av = (AV *)SvRV (arg);
8571 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8573 croak (\"malloc failed\");
8575 for (i = 0; i <= av_len (av); i++) {
8576 SV **elem = av_fetch (av, i, 0);
8578 if (!elem || !*elem)
8579 croak (\"missing element in list\");
8581 ret[i] = SvPV_nolen (*elem);
8589 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8596 RETVAL = guestfs_create ();
8598 croak (\"could not create guestfs handle\");
8599 guestfs_set_error_handler (RETVAL, NULL, NULL);
8612 fun (name, style, _, _, _, _, _) ->
8613 (match fst style with
8614 | RErr -> pr "void\n"
8615 | RInt _ -> pr "SV *\n"
8616 | RInt64 _ -> pr "SV *\n"
8617 | RBool _ -> pr "SV *\n"
8618 | RConstString _ -> pr "SV *\n"
8619 | RConstOptString _ -> pr "SV *\n"
8620 | RString _ -> pr "SV *\n"
8621 | RBufferOut _ -> pr "SV *\n"
8623 | RStruct _ | RStructList _
8625 pr "void\n" (* all lists returned implictly on the stack *)
8627 (* Call and arguments. *)
8630 fun arg -> pr ", %s" (name_of_argt arg)
8633 pr " guestfs_h *g;\n";
8637 | Pathname n | Device n | Dev_or_Path n | String n
8638 | FileIn n | FileOut n ->
8641 pr " char *%s;\n" n;
8642 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
8644 (* http://www.perlmonks.org/?node_id=554277
8645 * Note that the implicit handle argument means we have
8646 * to add 1 to the ST(x) operator.
8648 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8649 | StringList n | DeviceList n -> pr " char **%s;\n" n
8650 | Bool n -> pr " int %s;\n" n
8651 | Int n -> pr " int %s;\n" n
8652 | Int64 n -> pr " int64_t %s;\n" n
8655 let do_cleanups () =
8658 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8659 | Bool _ | Int _ | Int64 _
8660 | FileIn _ | FileOut _
8662 | StringList n | DeviceList n -> pr " free (%s);\n" n
8667 (match fst style with
8672 pr " r = guestfs_%s " name;
8673 generate_c_call_args ~handle:"g" style;
8676 pr " if (r == -1)\n";
8677 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8683 pr " %s = guestfs_%s " n name;
8684 generate_c_call_args ~handle:"g" style;
8687 pr " if (%s == -1)\n" n;
8688 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8689 pr " RETVAL = newSViv (%s);\n" n;
8694 pr " int64_t %s;\n" n;
8696 pr " %s = guestfs_%s " n name;
8697 generate_c_call_args ~handle:"g" style;
8700 pr " if (%s == -1)\n" n;
8701 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8702 pr " RETVAL = my_newSVll (%s);\n" n;
8707 pr " const char *%s;\n" n;
8709 pr " %s = guestfs_%s " n name;
8710 generate_c_call_args ~handle:"g" style;
8713 pr " if (%s == NULL)\n" n;
8714 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8715 pr " RETVAL = newSVpv (%s, 0);\n" n;
8718 | RConstOptString n ->
8720 pr " const char *%s;\n" n;
8722 pr " %s = guestfs_%s " n name;
8723 generate_c_call_args ~handle:"g" style;
8726 pr " if (%s == NULL)\n" n;
8727 pr " RETVAL = &PL_sv_undef;\n";
8729 pr " RETVAL = newSVpv (%s, 0);\n" n;
8734 pr " char *%s;\n" n;
8736 pr " %s = guestfs_%s " n name;
8737 generate_c_call_args ~handle:"g" style;
8740 pr " if (%s == NULL)\n" n;
8741 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8742 pr " RETVAL = newSVpv (%s, 0);\n" n;
8743 pr " free (%s);\n" n;
8746 | RStringList n | RHashtable n ->
8748 pr " char **%s;\n" n;
8751 pr " %s = guestfs_%s " n name;
8752 generate_c_call_args ~handle:"g" style;
8755 pr " if (%s == NULL)\n" n;
8756 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8757 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8758 pr " EXTEND (SP, n);\n";
8759 pr " for (i = 0; i < n; ++i) {\n";
8760 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8761 pr " free (%s[i]);\n" n;
8763 pr " free (%s);\n" n;
8764 | RStruct (n, typ) ->
8765 let cols = cols_of_struct typ in
8766 generate_perl_struct_code typ cols name style n do_cleanups
8767 | RStructList (n, typ) ->
8768 let cols = cols_of_struct typ in
8769 generate_perl_struct_list_code typ cols name style n do_cleanups
8772 pr " char *%s;\n" n;
8773 pr " size_t size;\n";
8775 pr " %s = guestfs_%s " n name;
8776 generate_c_call_args ~handle:"g" style;
8779 pr " if (%s == NULL)\n" n;
8780 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8781 pr " RETVAL = newSVpvn (%s, size);\n" n;
8782 pr " free (%s);\n" n;
8790 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8792 pr " struct guestfs_%s_list *%s;\n" typ n;
8796 pr " %s = guestfs_%s " n name;
8797 generate_c_call_args ~handle:"g" style;
8800 pr " if (%s == NULL)\n" n;
8801 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8802 pr " EXTEND (SP, %s->len);\n" n;
8803 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8804 pr " hv = newHV ();\n";
8808 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8809 name (String.length name) n name
8811 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8812 name (String.length name) n name
8814 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8815 name (String.length name) n name n name
8816 | name, (FBytes|FUInt64) ->
8817 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8818 name (String.length name) n name
8820 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8821 name (String.length name) n name
8822 | name, (FInt32|FUInt32) ->
8823 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8824 name (String.length name) n name
8826 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8827 name (String.length name) n name
8828 | name, FOptPercent ->
8829 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8830 name (String.length name) n name
8832 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8834 pr " guestfs_free_%s_list (%s);\n" typ n
8836 and generate_perl_struct_code typ cols name style n do_cleanups =
8838 pr " struct guestfs_%s *%s;\n" typ n;
8840 pr " %s = guestfs_%s " n name;
8841 generate_c_call_args ~handle:"g" style;
8844 pr " if (%s == NULL)\n" n;
8845 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8846 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8848 fun ((name, _) as col) ->
8849 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8853 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8856 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
8859 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8861 | name, (FBytes|FUInt64) ->
8862 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8865 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8867 | name, (FInt32|FUInt32) ->
8868 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8871 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8873 | name, FOptPercent ->
8874 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8877 pr " free (%s);\n" n
8879 (* Generate Sys/Guestfs.pm. *)
8880 and generate_perl_pm () =
8881 generate_header HashStyle LGPLv2plus;
8888 Sys::Guestfs - Perl bindings for libguestfs
8894 my $h = Sys::Guestfs->new ();
8895 $h->add_drive ('guest.img');
8897 $h->mount ('/dev/sda1', '/');
8898 $h->touch ('/hello');
8903 The C<Sys::Guestfs> module provides a Perl XS binding to the
8904 libguestfs API for examining and modifying virtual machine
8907 Amongst the things this is good for: making batch configuration
8908 changes to guests, getting disk used/free statistics (see also:
8909 virt-df), migrating between virtualization systems (see also:
8910 virt-p2v), performing partial backups, performing partial guest
8911 clones, cloning guests and changing registry/UUID/hostname info, and
8914 Libguestfs uses Linux kernel and qemu code, and can access any type of
8915 guest filesystem that Linux and qemu can, including but not limited
8916 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8917 schemes, qcow, qcow2, vmdk.
8919 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8920 LVs, what filesystem is in each LV, etc.). It can also run commands
8921 in the context of the guest. Also you can access filesystems over
8924 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8925 functions for using libguestfs from Perl, including integration
8930 All errors turn into calls to C<croak> (see L<Carp(3)>).
8938 package Sys::Guestfs;
8943 # This version number changes whenever a new function
8944 # is added to the libguestfs API. It is not directly
8945 # related to the libguestfs version number.
8946 use vars qw($VERSION);
8950 XSLoader::load ('Sys::Guestfs');
8952 =item $h = Sys::Guestfs->new ();
8954 Create a new guestfs handle.
8960 my $class = ref ($proto) || $proto;
8962 my $self = Sys::Guestfs::_create ();
8963 bless $self, $class;
8969 (* Actions. We only need to print documentation for these as
8970 * they are pulled in from the XS code automatically.
8973 fun (name, style, _, flags, _, _, longdesc) ->
8974 if not (List.mem NotInDocs flags) then (
8975 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
8977 generate_perl_prototype name style;
8979 pr "%s\n\n" longdesc;
8980 if List.mem ProtocolLimitWarning flags then
8981 pr "%s\n\n" protocol_limit_warning;
8982 if List.mem DangerWillRobinson flags then
8983 pr "%s\n\n" danger_will_robinson;
8984 match deprecation_notice flags with
8986 | Some txt -> pr "%s\n\n" txt
8988 ) all_functions_sorted;
9000 Copyright (C) %s Red Hat Inc.
9004 Please see the file COPYING.LIB for the full license.
9010 L<http://libguestfs.org>,
9011 L<Sys::Guestfs::Lib(3)>.
9016 and generate_perl_prototype name style =
9017 (match fst style with
9025 | RBufferOut n -> pr "$%s = " n
9027 | RHashtable n -> pr "%%%s = " n
9029 | RStructList (n,_) -> pr "@%s = " n
9032 let comma = ref false in
9035 if !comma then pr ", ";
9038 | Pathname n | Device n | Dev_or_Path n | String n
9039 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9042 | StringList n | DeviceList n ->
9047 (* Generate Python C module. *)
9048 and generate_python_c () =
9049 generate_header CStyle LGPLv2plus;
9052 #define PY_SSIZE_T_CLEAN 1
9059 #include \"guestfs.h\"
9067 get_handle (PyObject *obj)
9070 assert (obj != Py_None);
9071 return ((Pyguestfs_Object *) obj)->g;
9075 put_handle (guestfs_h *g)
9079 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9082 /* This list should be freed (but not the strings) after use. */
9084 get_string_list (PyObject *obj)
9091 if (!PyList_Check (obj)) {
9092 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9096 len = PyList_Size (obj);
9097 r = malloc (sizeof (char *) * (len+1));
9099 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9103 for (i = 0; i < len; ++i)
9104 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9111 put_string_list (char * const * const argv)
9116 for (argc = 0; argv[argc] != NULL; ++argc)
9119 list = PyList_New (argc);
9120 for (i = 0; i < argc; ++i)
9121 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9127 put_table (char * const * const argv)
9129 PyObject *list, *item;
9132 for (argc = 0; argv[argc] != NULL; ++argc)
9135 list = PyList_New (argc >> 1);
9136 for (i = 0; i < argc; i += 2) {
9137 item = PyTuple_New (2);
9138 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9139 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9140 PyList_SetItem (list, i >> 1, item);
9147 free_strings (char **argv)
9151 for (argc = 0; argv[argc] != NULL; ++argc)
9157 py_guestfs_create (PyObject *self, PyObject *args)
9161 g = guestfs_create ();
9163 PyErr_SetString (PyExc_RuntimeError,
9164 \"guestfs.create: failed to allocate handle\");
9167 guestfs_set_error_handler (g, NULL, NULL);
9168 return put_handle (g);
9172 py_guestfs_close (PyObject *self, PyObject *args)
9177 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9179 g = get_handle (py_g);
9183 Py_INCREF (Py_None);
9189 let emit_put_list_function typ =
9190 pr "static PyObject *\n";
9191 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9193 pr " PyObject *list;\n";
9196 pr " list = PyList_New (%ss->len);\n" typ;
9197 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9198 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9199 pr " return list;\n";
9204 (* Structures, turned into Python dictionaries. *)
9207 pr "static PyObject *\n";
9208 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9210 pr " PyObject *dict;\n";
9212 pr " dict = PyDict_New ();\n";
9216 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9217 pr " PyString_FromString (%s->%s));\n"
9220 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9221 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9224 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9225 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9227 | name, (FBytes|FUInt64) ->
9228 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9229 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9232 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9233 pr " PyLong_FromLongLong (%s->%s));\n"
9236 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9237 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9240 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9241 pr " PyLong_FromLong (%s->%s));\n"
9243 | name, FOptPercent ->
9244 pr " if (%s->%s >= 0)\n" typ name;
9245 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9246 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9249 pr " Py_INCREF (Py_None);\n";
9250 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9253 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9254 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9256 pr " return dict;\n";
9262 (* Emit a put_TYPE_list function definition only if that function is used. *)
9265 | typ, (RStructListOnly | RStructAndList) ->
9266 (* generate the function for typ *)
9267 emit_put_list_function typ
9268 | typ, _ -> () (* empty *)
9269 ) (rstructs_used_by all_functions);
9271 (* Python wrapper functions. *)
9273 fun (name, style, _, _, _, _, _) ->
9274 pr "static PyObject *\n";
9275 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9278 pr " PyObject *py_g;\n";
9279 pr " guestfs_h *g;\n";
9280 pr " PyObject *py_r;\n";
9283 match fst style with
9284 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9285 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9286 | RConstString _ | RConstOptString _ ->
9287 pr " const char *r;\n"; "NULL"
9288 | RString _ -> pr " char *r;\n"; "NULL"
9289 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9290 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9291 | RStructList (_, typ) ->
9292 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9295 pr " size_t size;\n";
9300 | Pathname n | Device n | Dev_or_Path n | String n
9301 | FileIn n | FileOut n ->
9302 pr " const char *%s;\n" n
9303 | OptString n -> pr " const char *%s;\n" n
9305 pr " const char *%s;\n" n;
9306 pr " Py_ssize_t %s_size;\n" n
9307 | StringList n | DeviceList n ->
9308 pr " PyObject *py_%s;\n" n;
9309 pr " char **%s;\n" n
9310 | Bool n -> pr " int %s;\n" n
9311 | Int n -> pr " int %s;\n" n
9312 | Int64 n -> pr " long long %s;\n" n
9317 (* Convert the parameters. *)
9318 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9321 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9322 | OptString _ -> pr "z"
9323 | StringList _ | DeviceList _ -> pr "O"
9324 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9326 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9327 * emulate C's int/long/long long in Python?
9329 | BufferIn _ -> pr "s#"
9331 pr ":guestfs_%s\",\n" name;
9335 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9336 | OptString n -> pr ", &%s" n
9337 | StringList n | DeviceList n -> pr ", &py_%s" n
9338 | Bool n -> pr ", &%s" n
9339 | Int n -> pr ", &%s" n
9340 | Int64 n -> pr ", &%s" n
9341 | BufferIn n -> pr ", &%s, &%s_size" n n
9345 pr " return NULL;\n";
9347 pr " g = get_handle (py_g);\n";
9350 | Pathname _ | Device _ | Dev_or_Path _ | String _
9351 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9353 | StringList n | DeviceList n ->
9354 pr " %s = get_string_list (py_%s);\n" n n;
9355 pr " if (!%s) return NULL;\n" n
9360 pr " r = guestfs_%s " name;
9361 generate_c_call_args ~handle:"g" style;
9366 | Pathname _ | Device _ | Dev_or_Path _ | String _
9367 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9369 | StringList n | DeviceList n ->
9370 pr " free (%s);\n" n
9373 pr " if (r == %s) {\n" error_code;
9374 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9375 pr " return NULL;\n";
9379 (match fst style with
9381 pr " Py_INCREF (Py_None);\n";
9382 pr " py_r = Py_None;\n"
9384 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9385 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9386 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9387 | RConstOptString _ ->
9389 pr " py_r = PyString_FromString (r);\n";
9391 pr " Py_INCREF (Py_None);\n";
9392 pr " py_r = Py_None;\n";
9395 pr " py_r = PyString_FromString (r);\n";
9398 pr " py_r = put_string_list (r);\n";
9399 pr " free_strings (r);\n"
9400 | RStruct (_, typ) ->
9401 pr " py_r = put_%s (r);\n" typ;
9402 pr " guestfs_free_%s (r);\n" typ
9403 | RStructList (_, typ) ->
9404 pr " py_r = put_%s_list (r);\n" typ;
9405 pr " guestfs_free_%s_list (r);\n" typ
9407 pr " py_r = put_table (r);\n";
9408 pr " free_strings (r);\n"
9410 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9414 pr " return py_r;\n";
9419 (* Table of functions. *)
9420 pr "static PyMethodDef methods[] = {\n";
9421 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9422 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9424 fun (name, _, _, _, _, _, _) ->
9425 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9428 pr " { NULL, NULL, 0, NULL }\n";
9432 (* Init function. *)
9435 initlibguestfsmod (void)
9437 static int initialized = 0;
9439 if (initialized) return;
9440 Py_InitModule ((char *) \"libguestfsmod\", methods);
9445 (* Generate Python module. *)
9446 and generate_python_py () =
9447 generate_header HashStyle LGPLv2plus;
9450 u\"\"\"Python bindings for libguestfs
9453 g = guestfs.GuestFS ()
9454 g.add_drive (\"guest.img\")
9456 parts = g.list_partitions ()
9458 The guestfs module provides a Python binding to the libguestfs API
9459 for examining and modifying virtual machine disk images.
9461 Amongst the things this is good for: making batch configuration
9462 changes to guests, getting disk used/free statistics (see also:
9463 virt-df), migrating between virtualization systems (see also:
9464 virt-p2v), performing partial backups, performing partial guest
9465 clones, cloning guests and changing registry/UUID/hostname info, and
9468 Libguestfs uses Linux kernel and qemu code, and can access any type of
9469 guest filesystem that Linux and qemu can, including but not limited
9470 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9471 schemes, qcow, qcow2, vmdk.
9473 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9474 LVs, what filesystem is in each LV, etc.). It can also run commands
9475 in the context of the guest. Also you can access filesystems over
9478 Errors which happen while using the API are turned into Python
9479 RuntimeError exceptions.
9481 To create a guestfs handle you usually have to perform the following
9484 # Create the handle, call add_drive at least once, and possibly
9485 # several times if the guest has multiple block devices:
9486 g = guestfs.GuestFS ()
9487 g.add_drive (\"guest.img\")
9489 # Launch the qemu subprocess and wait for it to become ready:
9492 # Now you can issue commands, for example:
9497 import libguestfsmod
9500 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9502 def __init__ (self):
9503 \"\"\"Create a new libguestfs handle.\"\"\"
9504 self._o = libguestfsmod.create ()
9507 libguestfsmod.close (self._o)
9512 fun (name, style, _, flags, _, _, longdesc) ->
9514 generate_py_call_args ~handle:"self" (snd style);
9517 if not (List.mem NotInDocs flags) then (
9518 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9520 match fst style with
9521 | RErr | RInt _ | RInt64 _ | RBool _
9522 | RConstOptString _ | RConstString _
9523 | RString _ | RBufferOut _ -> doc
9525 doc ^ "\n\nThis function returns a list of strings."
9526 | RStruct (_, typ) ->
9527 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9528 | RStructList (_, typ) ->
9529 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9531 doc ^ "\n\nThis function returns a dictionary." in
9533 if List.mem ProtocolLimitWarning flags then
9534 doc ^ "\n\n" ^ protocol_limit_warning
9537 if List.mem DangerWillRobinson flags then
9538 doc ^ "\n\n" ^ danger_will_robinson
9541 match deprecation_notice flags with
9543 | Some txt -> doc ^ "\n\n" ^ txt in
9544 let doc = pod2text ~width:60 name doc in
9545 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9546 let doc = String.concat "\n " doc in
9547 pr " u\"\"\"%s\"\"\"\n" doc;
9549 pr " return libguestfsmod.%s " name;
9550 generate_py_call_args ~handle:"self._o" (snd style);
9555 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9556 and generate_py_call_args ~handle args =
9558 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9561 (* Useful if you need the longdesc POD text as plain text. Returns a
9564 * Because this is very slow (the slowest part of autogeneration),
9565 * we memoize the results.
9567 and pod2text ~width name longdesc =
9568 let key = width, name, longdesc in
9569 try Hashtbl.find pod2text_memo key
9571 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9572 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9574 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9575 let chan = open_process_in cmd in
9576 let lines = ref [] in
9578 let line = input_line chan in
9579 if i = 1 then (* discard the first line of output *)
9582 let line = triml line in
9583 lines := line :: !lines;
9586 let lines = try loop 1 with End_of_file -> List.rev !lines in
9588 (match close_process_in chan with
9591 failwithf "pod2text: process exited with non-zero status (%d)" i
9592 | WSIGNALED i | WSTOPPED i ->
9593 failwithf "pod2text: process signalled or stopped by signal %d" i
9595 Hashtbl.add pod2text_memo key lines;
9596 pod2text_memo_updated ();
9599 (* Generate ruby bindings. *)
9600 and generate_ruby_c () =
9601 generate_header CStyle LGPLv2plus;
9609 #include \"guestfs.h\"
9611 #include \"extconf.h\"
9613 /* For Ruby < 1.9 */
9615 #define RARRAY_LEN(r) (RARRAY((r))->len)
9618 static VALUE m_guestfs; /* guestfs module */
9619 static VALUE c_guestfs; /* guestfs_h handle */
9620 static VALUE e_Error; /* used for all errors */
9622 static void ruby_guestfs_free (void *p)
9625 guestfs_close ((guestfs_h *) p);
9628 static VALUE ruby_guestfs_create (VALUE m)
9632 g = guestfs_create ();
9634 rb_raise (e_Error, \"failed to create guestfs handle\");
9636 /* Don't print error messages to stderr by default. */
9637 guestfs_set_error_handler (g, NULL, NULL);
9639 /* Wrap it, and make sure the close function is called when the
9642 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9645 static VALUE ruby_guestfs_close (VALUE gv)
9648 Data_Get_Struct (gv, guestfs_h, g);
9650 ruby_guestfs_free (g);
9651 DATA_PTR (gv) = NULL;
9659 fun (name, style, _, _, _, _, _) ->
9660 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9661 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9664 pr " guestfs_h *g;\n";
9665 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9667 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9673 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9674 pr " Check_Type (%sv, T_STRING);\n" n;
9675 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9677 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9678 pr " \"%s\", \"%s\");\n" n name
9680 pr " Check_Type (%sv, T_STRING);\n" n;
9681 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
9683 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9684 pr " \"%s\", \"%s\");\n" n name;
9685 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
9687 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9688 | StringList n | DeviceList n ->
9689 pr " char **%s;\n" n;
9690 pr " Check_Type (%sv, T_ARRAY);\n" n;
9692 pr " int i, len;\n";
9693 pr " len = RARRAY_LEN (%sv);\n" n;
9694 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9696 pr " for (i = 0; i < len; ++i) {\n";
9697 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9698 pr " %s[i] = StringValueCStr (v);\n" n;
9700 pr " %s[len] = NULL;\n" n;
9703 pr " int %s = RTEST (%sv);\n" n n
9705 pr " int %s = NUM2INT (%sv);\n" n n
9707 pr " long long %s = NUM2LL (%sv);\n" n n
9712 match fst style with
9713 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9714 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9715 | RConstString _ | RConstOptString _ ->
9716 pr " const char *r;\n"; "NULL"
9717 | RString _ -> pr " char *r;\n"; "NULL"
9718 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9719 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9720 | RStructList (_, typ) ->
9721 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9724 pr " size_t size;\n";
9728 pr " r = guestfs_%s " name;
9729 generate_c_call_args ~handle:"g" style;
9734 | Pathname _ | Device _ | Dev_or_Path _ | String _
9735 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9737 | StringList n | DeviceList n ->
9738 pr " free (%s);\n" n
9741 pr " if (r == %s)\n" error_code;
9742 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9745 (match fst style with
9747 pr " return Qnil;\n"
9748 | RInt _ | RBool _ ->
9749 pr " return INT2NUM (r);\n"
9751 pr " return ULL2NUM (r);\n"
9753 pr " return rb_str_new2 (r);\n";
9754 | RConstOptString _ ->
9756 pr " return rb_str_new2 (r);\n";
9758 pr " return Qnil;\n";
9760 pr " VALUE rv = rb_str_new2 (r);\n";
9764 pr " int i, len = 0;\n";
9765 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9766 pr " VALUE rv = rb_ary_new2 (len);\n";
9767 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9768 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9769 pr " free (r[i]);\n";
9773 | RStruct (_, typ) ->
9774 let cols = cols_of_struct typ in
9775 generate_ruby_struct_code typ cols
9776 | RStructList (_, typ) ->
9777 let cols = cols_of_struct typ in
9778 generate_ruby_struct_list_code typ cols
9780 pr " VALUE rv = rb_hash_new ();\n";
9782 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9783 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9784 pr " free (r[i]);\n";
9785 pr " free (r[i+1]);\n";
9790 pr " VALUE rv = rb_str_new (r, size);\n";
9800 /* Initialize the module. */
9801 void Init__guestfs ()
9803 m_guestfs = rb_define_module (\"Guestfs\");
9804 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9805 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9807 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9808 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9811 (* Define the rest of the methods. *)
9813 fun (name, style, _, _, _, _, _) ->
9814 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9815 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9820 (* Ruby code to return a struct. *)
9821 and generate_ruby_struct_code typ cols =
9822 pr " VALUE rv = rb_hash_new ();\n";
9826 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9828 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9830 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9831 | name, (FBytes|FUInt64) ->
9832 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9834 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9836 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9838 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9839 | name, FOptPercent ->
9840 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9841 | name, FChar -> (* XXX wrong? *)
9842 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9844 pr " guestfs_free_%s (r);\n" typ;
9847 (* Ruby code to return a struct list. *)
9848 and generate_ruby_struct_list_code typ cols =
9849 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9851 pr " for (i = 0; i < r->len; ++i) {\n";
9852 pr " VALUE hv = rb_hash_new ();\n";
9856 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9858 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
9860 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9861 | name, (FBytes|FUInt64) ->
9862 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9864 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9866 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9868 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9869 | name, FOptPercent ->
9870 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9871 | name, FChar -> (* XXX wrong? *)
9872 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9874 pr " rb_ary_push (rv, hv);\n";
9876 pr " guestfs_free_%s_list (r);\n" typ;
9879 (* Generate Java bindings GuestFS.java file. *)
9880 and generate_java_java () =
9881 generate_header CStyle LGPLv2plus;
9884 package com.redhat.et.libguestfs;
9886 import java.util.HashMap;
9887 import com.redhat.et.libguestfs.LibGuestFSException;
9888 import com.redhat.et.libguestfs.PV;
9889 import com.redhat.et.libguestfs.VG;
9890 import com.redhat.et.libguestfs.LV;
9891 import com.redhat.et.libguestfs.Stat;
9892 import com.redhat.et.libguestfs.StatVFS;
9893 import com.redhat.et.libguestfs.IntBool;
9894 import com.redhat.et.libguestfs.Dirent;
9897 * The GuestFS object is a libguestfs handle.
9901 public class GuestFS {
9902 // Load the native code.
9904 System.loadLibrary (\"guestfs_jni\");
9908 * The native guestfs_h pointer.
9913 * Create a libguestfs handle.
9915 * @throws LibGuestFSException
9917 public GuestFS () throws LibGuestFSException
9921 private native long _create () throws LibGuestFSException;
9924 * Close a libguestfs handle.
9926 * You can also leave handles to be collected by the garbage
9927 * collector, but this method ensures that the resources used
9928 * by the handle are freed up immediately. If you call any
9929 * other methods after closing the handle, you will get an
9932 * @throws LibGuestFSException
9934 public void close () throws LibGuestFSException
9940 private native void _close (long g) throws LibGuestFSException;
9942 public void finalize () throws LibGuestFSException
9950 fun (name, style, _, flags, _, shortdesc, longdesc) ->
9951 if not (List.mem NotInDocs flags); then (
9952 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9954 if List.mem ProtocolLimitWarning flags then
9955 doc ^ "\n\n" ^ protocol_limit_warning
9958 if List.mem DangerWillRobinson flags then
9959 doc ^ "\n\n" ^ danger_will_robinson
9962 match deprecation_notice flags with
9964 | Some txt -> doc ^ "\n\n" ^ txt in
9965 let doc = pod2text ~width:60 name doc in
9966 let doc = List.map ( (* RHBZ#501883 *)
9969 | nonempty -> nonempty
9971 let doc = String.concat "\n * " doc in
9974 pr " * %s\n" shortdesc;
9977 pr " * @throws LibGuestFSException\n";
9981 generate_java_prototype ~public:true ~semicolon:false name style;
9984 pr " if (g == 0)\n";
9985 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
9988 if fst style <> RErr then pr "return ";
9990 generate_java_call_args ~handle:"g" (snd style);
9994 generate_java_prototype ~privat:true ~native:true name style;
10001 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10002 and generate_java_call_args ~handle args =
10004 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10007 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10008 ?(semicolon=true) name style =
10009 if privat then pr "private ";
10010 if public then pr "public ";
10011 if native then pr "native ";
10014 (match fst style with
10015 | RErr -> pr "void ";
10016 | RInt _ -> pr "int ";
10017 | RInt64 _ -> pr "long ";
10018 | RBool _ -> pr "boolean ";
10019 | RConstString _ | RConstOptString _ | RString _
10020 | RBufferOut _ -> pr "String ";
10021 | RStringList _ -> pr "String[] ";
10022 | RStruct (_, typ) ->
10023 let name = java_name_of_struct typ in
10025 | RStructList (_, typ) ->
10026 let name = java_name_of_struct typ in
10028 | RHashtable _ -> pr "HashMap<String,String> ";
10031 if native then pr "_%s " name else pr "%s " name;
10033 let needs_comma = ref false in
10036 needs_comma := true
10042 if !needs_comma then pr ", ";
10043 needs_comma := true;
10047 | Device n | Dev_or_Path n
10055 | StringList n | DeviceList n ->
10066 pr " throws LibGuestFSException";
10067 if semicolon then pr ";"
10069 and generate_java_struct jtyp cols () =
10070 generate_header CStyle LGPLv2plus;
10073 package com.redhat.et.libguestfs;
10076 * Libguestfs %s structure.
10088 | name, FBuffer -> pr " public String %s;\n" name
10089 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10090 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10091 | name, FChar -> pr " public char %s;\n" name
10092 | name, FOptPercent ->
10093 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10094 pr " public float %s;\n" name
10099 and generate_java_c () =
10100 generate_header CStyle LGPLv2plus;
10104 #include <stdlib.h>
10105 #include <string.h>
10107 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10108 #include \"guestfs.h\"
10110 /* Note that this function returns. The exception is not thrown
10111 * until after the wrapper function returns.
10114 throw_exception (JNIEnv *env, const char *msg)
10117 cl = (*env)->FindClass (env,
10118 \"com/redhat/et/libguestfs/LibGuestFSException\");
10119 (*env)->ThrowNew (env, cl, msg);
10122 JNIEXPORT jlong JNICALL
10123 Java_com_redhat_et_libguestfs_GuestFS__1create
10124 (JNIEnv *env, jobject obj)
10128 g = guestfs_create ();
10130 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10133 guestfs_set_error_handler (g, NULL, NULL);
10134 return (jlong) (long) g;
10137 JNIEXPORT void JNICALL
10138 Java_com_redhat_et_libguestfs_GuestFS__1close
10139 (JNIEnv *env, jobject obj, jlong jg)
10141 guestfs_h *g = (guestfs_h *) (long) jg;
10148 fun (name, style, _, _, _, _, _) ->
10150 (match fst style with
10151 | RErr -> pr "void ";
10152 | RInt _ -> pr "jint ";
10153 | RInt64 _ -> pr "jlong ";
10154 | RBool _ -> pr "jboolean ";
10155 | RConstString _ | RConstOptString _ | RString _
10156 | RBufferOut _ -> pr "jstring ";
10157 | RStruct _ | RHashtable _ ->
10159 | RStringList _ | RStructList _ ->
10160 pr "jobjectArray ";
10163 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10164 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10166 pr " (JNIEnv *env, jobject obj, jlong jg";
10170 | Device n | Dev_or_Path n
10175 pr ", jstring j%s" n
10177 pr ", jbyteArray j%s" n
10178 | StringList n | DeviceList n ->
10179 pr ", jobjectArray j%s" n
10181 pr ", jboolean j%s" n
10189 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10190 let error_code, no_ret =
10191 match fst style with
10192 | RErr -> pr " int r;\n"; "-1", ""
10194 | RInt _ -> pr " int r;\n"; "-1", "0"
10195 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10196 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10197 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10199 pr " jstring jr;\n";
10200 pr " char *r;\n"; "NULL", "NULL"
10202 pr " jobjectArray jr;\n";
10203 pr " int r_len;\n";
10204 pr " jclass cl;\n";
10205 pr " jstring jstr;\n";
10206 pr " char **r;\n"; "NULL", "NULL"
10207 | RStruct (_, typ) ->
10208 pr " jobject jr;\n";
10209 pr " jclass cl;\n";
10210 pr " jfieldID fl;\n";
10211 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10212 | RStructList (_, typ) ->
10213 pr " jobjectArray jr;\n";
10214 pr " jclass cl;\n";
10215 pr " jfieldID fl;\n";
10216 pr " jobject jfl;\n";
10217 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10218 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10220 pr " jstring jr;\n";
10222 pr " size_t size;\n";
10227 | Device n | Dev_or_Path n
10232 pr " const char *%s;\n" n
10234 pr " jbyte *%s;\n" n;
10235 pr " size_t %s_size;\n" n
10236 | StringList n | DeviceList n ->
10237 pr " int %s_len;\n" n;
10238 pr " const char **%s;\n" n
10243 pr " int64_t %s;\n" n
10247 (match fst style with
10248 | RStringList _ | RStructList _ -> true
10249 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10250 | RConstOptString _
10251 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10252 List.exists (function
10253 | StringList _ -> true
10254 | DeviceList _ -> true
10255 | _ -> false) (snd style) in
10261 (* Get the parameters. *)
10265 | Device n | Dev_or_Path n
10269 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10271 (* This is completely undocumented, but Java null becomes
10272 * a NULL parameter.
10274 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10276 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10277 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10278 | StringList n | DeviceList n ->
10279 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10280 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10281 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10282 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10284 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10286 pr " %s[%s_len] = NULL;\n" n n;
10290 pr " %s = j%s;\n" n n
10293 (* Make the call. *)
10294 pr " r = guestfs_%s " name;
10295 generate_c_call_args ~handle:"g" style;
10298 (* Release the parameters. *)
10302 | Device n | Dev_or_Path n
10306 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10308 pr " if (j%s)\n" n;
10309 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10311 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10312 | StringList n | DeviceList n ->
10313 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10314 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10316 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10318 pr " free (%s);\n" n
10324 (* Check for errors. *)
10325 pr " if (r == %s) {\n" error_code;
10326 pr " throw_exception (env, guestfs_last_error (g));\n";
10327 pr " return %s;\n" no_ret;
10330 (* Return value. *)
10331 (match fst style with
10333 | RInt _ -> pr " return (jint) r;\n"
10334 | RBool _ -> pr " return (jboolean) r;\n"
10335 | RInt64 _ -> pr " return (jlong) r;\n"
10336 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10337 | RConstOptString _ ->
10338 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10340 pr " jr = (*env)->NewStringUTF (env, r);\n";
10344 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10345 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10346 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10347 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10348 pr " for (i = 0; i < r_len; ++i) {\n";
10349 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10350 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10351 pr " free (r[i]);\n";
10355 | RStruct (_, typ) ->
10356 let jtyp = java_name_of_struct typ in
10357 let cols = cols_of_struct typ in
10358 generate_java_struct_return typ jtyp cols
10359 | RStructList (_, typ) ->
10360 let jtyp = java_name_of_struct typ in
10361 let cols = cols_of_struct typ in
10362 generate_java_struct_list_return typ jtyp cols
10365 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10366 pr " return NULL;\n"
10368 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10377 and generate_java_struct_return typ jtyp cols =
10378 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10379 pr " jr = (*env)->AllocObject (env, cl);\n";
10383 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10384 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10387 pr " char s[33];\n";
10388 pr " memcpy (s, r->%s, 32);\n" name;
10389 pr " s[32] = 0;\n";
10390 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10391 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10395 pr " int len = r->%s_len;\n" name;
10396 pr " char s[len+1];\n";
10397 pr " memcpy (s, r->%s, len);\n" name;
10398 pr " s[len] = 0;\n";
10399 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10400 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10402 | name, (FBytes|FUInt64|FInt64) ->
10403 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10404 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10405 | name, (FUInt32|FInt32) ->
10406 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10407 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10408 | name, FOptPercent ->
10409 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10410 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10412 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10413 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10418 and generate_java_struct_list_return typ jtyp cols =
10419 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10420 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10421 pr " for (i = 0; i < r->len; ++i) {\n";
10422 pr " jfl = (*env)->AllocObject (env, cl);\n";
10426 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10427 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10430 pr " char s[33];\n";
10431 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10432 pr " s[32] = 0;\n";
10433 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10434 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10438 pr " int len = r->val[i].%s_len;\n" name;
10439 pr " char s[len+1];\n";
10440 pr " memcpy (s, r->val[i].%s, len);\n" name;
10441 pr " s[len] = 0;\n";
10442 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10443 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10445 | name, (FBytes|FUInt64|FInt64) ->
10446 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10447 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10448 | name, (FUInt32|FInt32) ->
10449 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10450 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10451 | name, FOptPercent ->
10452 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10453 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10455 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10456 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10458 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10460 pr " guestfs_free_%s_list (r);\n" typ;
10463 and generate_java_makefile_inc () =
10464 generate_header HashStyle GPLv2plus;
10466 pr "java_built_sources = \\\n";
10469 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10471 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10473 and generate_haskell_hs () =
10474 generate_header HaskellStyle LGPLv2plus;
10476 (* XXX We only know how to generate partial FFI for Haskell
10477 * at the moment. Please help out!
10479 let can_generate style =
10483 | RInt64 _, _ -> true
10485 | RConstString _, _
10486 | RConstOptString _, _
10492 | RBufferOut _, _ -> false in
10495 {-# INCLUDE <guestfs.h> #-}
10496 {-# LANGUAGE ForeignFunctionInterface #-}
10501 (* List out the names of the actions we want to export. *)
10503 fun (name, style, _, _, _, _, _) ->
10504 if can_generate style then pr ",\n %s" name
10510 -- Unfortunately some symbols duplicate ones already present
10511 -- in Prelude. We don't know which, so we hard-code a list
10513 import Prelude hiding (truncate)
10517 import Foreign.C.Types
10519 import Control.Exception
10520 import Data.Typeable
10522 data GuestfsS = GuestfsS -- represents the opaque C struct
10523 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10524 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10526 -- XXX define properly later XXX
10530 data IntBool = IntBool
10532 data StatVFS = StatVFS
10533 data Hashtable = Hashtable
10535 foreign import ccall unsafe \"guestfs_create\" c_create
10537 foreign import ccall unsafe \"&guestfs_close\" c_close
10538 :: FunPtr (GuestfsP -> IO ())
10539 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10540 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10542 create :: IO GuestfsH
10545 c_set_error_handler p nullPtr nullPtr
10546 h <- newForeignPtr c_close p
10549 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10550 :: GuestfsP -> IO CString
10552 -- last_error :: GuestfsH -> IO (Maybe String)
10553 -- last_error h = do
10554 -- str <- withForeignPtr h (\\p -> c_last_error p)
10555 -- maybePeek peekCString str
10557 last_error :: GuestfsH -> IO (String)
10559 str <- withForeignPtr h (\\p -> c_last_error p)
10560 if (str == nullPtr)
10561 then return \"no error\"
10562 else peekCString str
10566 (* Generate wrappers for each foreign function. *)
10568 fun (name, style, _, _, _, _, _) ->
10569 if can_generate style then (
10570 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10572 generate_haskell_prototype ~handle:"GuestfsP" style;
10576 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10578 pr "%s %s = do\n" name
10579 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10581 (* Convert pointer arguments using with* functions. *)
10586 | Pathname n | Device n | Dev_or_Path n | String n ->
10587 pr "withCString %s $ \\%s -> " n n
10589 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10590 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10591 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10592 | Bool _ | Int _ | Int64 _ -> ()
10594 (* Convert integer arguments. *)
10598 | Bool n -> sprintf "(fromBool %s)" n
10599 | Int n -> sprintf "(fromIntegral %s)" n
10600 | Int64 n -> sprintf "(fromIntegral %s)" n
10601 | FileIn n | FileOut n
10602 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10603 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
10605 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10606 (String.concat " " ("p" :: args));
10607 (match fst style with
10608 | RErr | RInt _ | RInt64 _ | RBool _ ->
10609 pr " if (r == -1)\n";
10611 pr " err <- last_error h\n";
10613 | RConstString _ | RConstOptString _ | RString _
10614 | RStringList _ | RStruct _
10615 | RStructList _ | RHashtable _ | RBufferOut _ ->
10616 pr " if (r == nullPtr)\n";
10618 pr " err <- last_error h\n";
10621 (match fst style with
10623 pr " else return ()\n"
10625 pr " else return (fromIntegral r)\n"
10627 pr " else return (fromIntegral r)\n"
10629 pr " else return (toBool r)\n"
10631 | RConstOptString _
10638 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10644 and generate_haskell_prototype ~handle ?(hs = false) style =
10645 pr "%s -> " handle;
10646 let string = if hs then "String" else "CString" in
10647 let int = if hs then "Int" else "CInt" in
10648 let bool = if hs then "Bool" else "CInt" in
10649 let int64 = if hs then "Integer" else "Int64" in
10653 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10655 if hs then pr "String"
10656 else pr "CString -> CInt"
10657 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10658 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10659 | Bool _ -> pr "%s" bool
10660 | Int _ -> pr "%s" int
10661 | Int64 _ -> pr "%s" int
10662 | FileIn _ -> pr "%s" string
10663 | FileOut _ -> pr "%s" string
10668 (match fst style with
10669 | RErr -> if not hs then pr "CInt"
10670 | RInt _ -> pr "%s" int
10671 | RInt64 _ -> pr "%s" int64
10672 | RBool _ -> pr "%s" bool
10673 | RConstString _ -> pr "%s" string
10674 | RConstOptString _ -> pr "Maybe %s" string
10675 | RString _ -> pr "%s" string
10676 | RStringList _ -> pr "[%s]" string
10677 | RStruct (_, typ) ->
10678 let name = java_name_of_struct typ in
10680 | RStructList (_, typ) ->
10681 let name = java_name_of_struct typ in
10683 | RHashtable _ -> pr "Hashtable"
10684 | RBufferOut _ -> pr "%s" string
10688 and generate_csharp () =
10689 generate_header CPlusPlusStyle LGPLv2plus;
10691 (* XXX Make this configurable by the C# assembly users. *)
10692 let library = "libguestfs.so.0" in
10695 // These C# bindings are highly experimental at present.
10697 // Firstly they only work on Linux (ie. Mono). In order to get them
10698 // to work on Windows (ie. .Net) you would need to port the library
10699 // itself to Windows first.
10701 // The second issue is that some calls are known to be incorrect and
10702 // can cause Mono to segfault. Particularly: calls which pass or
10703 // return string[], or return any structure value. This is because
10704 // we haven't worked out the correct way to do this from C#.
10706 // The third issue is that when compiling you get a lot of warnings.
10707 // We are not sure whether the warnings are important or not.
10709 // Fourthly we do not routinely build or test these bindings as part
10710 // of the make && make check cycle, which means that regressions might
10713 // Suggestions and patches are welcome.
10717 // gmcs Libguestfs.cs
10718 // mono Libguestfs.exe
10720 // (You'll probably want to add a Test class / static main function
10721 // otherwise this won't do anything useful).
10725 using System.Runtime.InteropServices;
10726 using System.Runtime.Serialization;
10727 using System.Collections;
10731 class Error : System.ApplicationException
10733 public Error (string message) : base (message) {}
10734 protected Error (SerializationInfo info, StreamingContext context) {}
10741 [DllImport (\"%s\")]
10742 static extern IntPtr guestfs_create ();
10746 _handle = guestfs_create ();
10747 if (_handle == IntPtr.Zero)
10748 throw new Error (\"could not create guestfs handle\");
10751 [DllImport (\"%s\")]
10752 static extern void guestfs_close (IntPtr h);
10756 guestfs_close (_handle);
10759 [DllImport (\"%s\")]
10760 static extern string guestfs_last_error (IntPtr h);
10762 " library library library;
10764 (* Generate C# structure bindings. We prefix struct names with
10765 * underscore because C# cannot have conflicting struct names and
10766 * method names (eg. "class stat" and "stat").
10770 pr " [StructLayout (LayoutKind.Sequential)]\n";
10771 pr " public class _%s {\n" typ;
10774 | name, FChar -> pr " char %s;\n" name
10775 | name, FString -> pr " string %s;\n" name
10777 pr " uint %s_len;\n" name;
10778 pr " string %s;\n" name
10780 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10781 pr " string %s;\n" name
10782 | name, FUInt32 -> pr " uint %s;\n" name
10783 | name, FInt32 -> pr " int %s;\n" name
10784 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10785 | name, FInt64 -> pr " long %s;\n" name
10786 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10792 (* Generate C# function bindings. *)
10794 fun (name, style, _, _, _, shortdesc, _) ->
10795 let rec csharp_return_type () =
10796 match fst style with
10798 | RBool n -> "bool"
10800 | RInt64 n -> "long"
10802 | RConstOptString n
10804 | RBufferOut n -> "string"
10805 | RStruct (_,n) -> "_" ^ n
10806 | RHashtable n -> "Hashtable"
10807 | RStringList n -> "string[]"
10808 | RStructList (_,n) -> sprintf "_%s[]" n
10810 and c_return_type () =
10811 match fst style with
10815 | RInt64 _ -> "long"
10817 | RConstOptString _
10819 | RBufferOut _ -> "string"
10820 | RStruct (_,n) -> "_" ^ n
10822 | RStringList _ -> "string[]"
10823 | RStructList (_,n) -> sprintf "_%s[]" n
10825 and c_error_comparison () =
10826 match fst style with
10830 | RInt64 _ -> "== -1"
10832 | RConstOptString _
10838 | RStructList (_,_) -> "== null"
10840 and generate_extern_prototype () =
10841 pr " static extern %s guestfs_%s (IntPtr h"
10842 (c_return_type ()) name;
10845 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10846 | FileIn n | FileOut n
10848 pr ", [In] string %s" n
10849 | StringList n | DeviceList n ->
10850 pr ", [In] string[] %s" n
10860 and generate_public_prototype () =
10861 pr " public %s %s (" (csharp_return_type ()) name;
10862 let comma = ref false in
10864 if !comma then pr ", ";
10869 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10870 | FileIn n | FileOut n
10872 next (); pr "string %s" n
10873 | StringList n | DeviceList n ->
10874 next (); pr "string[] %s" n
10876 next (); pr "bool %s" n
10878 next (); pr "int %s" n
10880 next (); pr "long %s" n
10884 and generate_call () =
10885 pr "guestfs_%s (_handle" name;
10886 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10890 pr " [DllImport (\"%s\")]\n" library;
10891 generate_extern_prototype ();
10893 pr " /// <summary>\n";
10894 pr " /// %s\n" shortdesc;
10895 pr " /// </summary>\n";
10896 generate_public_prototype ();
10898 pr " %s r;\n" (c_return_type ());
10901 pr " if (r %s)\n" (c_error_comparison ());
10902 pr " throw new Error (guestfs_last_error (_handle));\n";
10903 (match fst style with
10906 pr " return r != 0 ? true : false;\n"
10908 pr " Hashtable rr = new Hashtable ();\n";
10909 pr " for (int i = 0; i < r.Length; i += 2)\n";
10910 pr " rr.Add (r[i], r[i+1]);\n";
10912 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10913 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10919 ) all_functions_sorted;
10925 and generate_bindtests () =
10926 generate_header CStyle LGPLv2plus;
10930 #include <stdlib.h>
10931 #include <inttypes.h>
10932 #include <string.h>
10934 #include \"guestfs.h\"
10935 #include \"guestfs-internal.h\"
10936 #include \"guestfs-internal-actions.h\"
10937 #include \"guestfs_protocol.h\"
10939 #define error guestfs_error
10940 #define safe_calloc guestfs_safe_calloc
10941 #define safe_malloc guestfs_safe_malloc
10944 print_strings (char *const *argv)
10949 for (argc = 0; argv[argc] != NULL; ++argc) {
10950 if (argc > 0) printf (\", \");
10951 printf (\"\\\"%%s\\\"\", argv[argc]);
10956 /* The test0 function prints its parameters to stdout. */
10960 match test_functions with
10961 | [] -> assert false
10962 | test0 :: tests -> test0, tests in
10965 let (name, style, _, _, _, _, _) = test0 in
10966 generate_prototype ~extern:false ~semicolon:false ~newline:true
10967 ~handle:"g" ~prefix:"guestfs__" name style;
10972 | Device n | Dev_or_Path n
10975 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
10977 pr " for (size_t i = 0; i < %s_size; ++i)\n" n;
10978 pr " printf (\"<%%02x>\", %s[i]);\n" n;
10979 pr " printf (\"\\n\");\n"
10980 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
10981 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
10982 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
10983 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
10984 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
10986 pr " /* Java changes stdout line buffering so we need this: */\n";
10987 pr " fflush (stdout);\n";
10993 fun (name, style, _, _, _, _, _) ->
10994 if String.sub name (String.length name - 3) 3 <> "err" then (
10995 pr "/* Test normal return. */\n";
10996 generate_prototype ~extern:false ~semicolon:false ~newline:true
10997 ~handle:"g" ~prefix:"guestfs__" name style;
10999 (match fst style with
11004 pr " sscanf (val, \"%%d\", &r);\n";
11007 pr " int64_t r;\n";
11008 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11011 pr " return STREQ (val, \"true\");\n"
11013 | RConstOptString _ ->
11014 (* Can't return the input string here. Return a static
11015 * string so we ensure we get a segfault if the caller
11016 * tries to free it.
11018 pr " return \"static string\";\n"
11020 pr " return strdup (val);\n"
11022 pr " char **strs;\n";
11024 pr " sscanf (val, \"%%d\", &n);\n";
11025 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11026 pr " for (i = 0; i < n; ++i) {\n";
11027 pr " strs[i] = safe_malloc (g, 16);\n";
11028 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11030 pr " strs[n] = NULL;\n";
11031 pr " return strs;\n"
11032 | RStruct (_, typ) ->
11033 pr " struct guestfs_%s *r;\n" typ;
11034 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11036 | RStructList (_, typ) ->
11037 pr " struct guestfs_%s_list *r;\n" typ;
11038 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11039 pr " sscanf (val, \"%%d\", &r->len);\n";
11040 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11043 pr " char **strs;\n";
11045 pr " sscanf (val, \"%%d\", &n);\n";
11046 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11047 pr " for (i = 0; i < n; ++i) {\n";
11048 pr " strs[i*2] = safe_malloc (g, 16);\n";
11049 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11050 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11051 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11053 pr " strs[n*2] = NULL;\n";
11054 pr " return strs;\n"
11056 pr " return strdup (val);\n"
11061 pr "/* Test error return. */\n";
11062 generate_prototype ~extern:false ~semicolon:false ~newline:true
11063 ~handle:"g" ~prefix:"guestfs__" name style;
11065 pr " error (g, \"error\");\n";
11066 (match fst style with
11067 | RErr | RInt _ | RInt64 _ | RBool _ ->
11069 | RConstString _ | RConstOptString _
11070 | RString _ | RStringList _ | RStruct _
11074 pr " return NULL;\n"
11081 and generate_ocaml_bindtests () =
11082 generate_header OCamlStyle GPLv2plus;
11086 let g = Guestfs.create () in
11090 String.concat " " (
11093 | CallString s -> "\"" ^ s ^ "\""
11094 | CallOptString None -> "None"
11095 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11096 | CallStringList xs ->
11097 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11098 | CallInt i when i >= 0 -> string_of_int i
11099 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11100 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11101 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11102 | CallBool b -> string_of_bool b
11103 | CallBuffer s -> sprintf "%S" s
11108 generate_lang_bindtests (
11109 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11112 pr "print_endline \"EOF\"\n"
11114 and generate_perl_bindtests () =
11115 pr "#!/usr/bin/perl -w\n";
11116 generate_header HashStyle GPLv2plus;
11123 my $g = Sys::Guestfs->new ();
11127 String.concat ", " (
11130 | CallString s -> "\"" ^ s ^ "\""
11131 | CallOptString None -> "undef"
11132 | CallOptString (Some s) -> sprintf "\"%s\"" s
11133 | CallStringList xs ->
11134 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11135 | CallInt i -> string_of_int i
11136 | CallInt64 i -> Int64.to_string i
11137 | CallBool b -> if b then "1" else "0"
11138 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11143 generate_lang_bindtests (
11144 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11147 pr "print \"EOF\\n\"\n"
11149 and generate_python_bindtests () =
11150 generate_header HashStyle GPLv2plus;
11155 g = guestfs.GuestFS ()
11159 String.concat ", " (
11162 | CallString s -> "\"" ^ s ^ "\""
11163 | CallOptString None -> "None"
11164 | CallOptString (Some s) -> sprintf "\"%s\"" s
11165 | CallStringList xs ->
11166 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11167 | CallInt i -> string_of_int i
11168 | CallInt64 i -> Int64.to_string i
11169 | CallBool b -> if b then "1" else "0"
11170 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11175 generate_lang_bindtests (
11176 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11179 pr "print \"EOF\"\n"
11181 and generate_ruby_bindtests () =
11182 generate_header HashStyle GPLv2plus;
11187 g = Guestfs::create()
11191 String.concat ", " (
11194 | CallString s -> "\"" ^ s ^ "\""
11195 | CallOptString None -> "nil"
11196 | CallOptString (Some s) -> sprintf "\"%s\"" s
11197 | CallStringList xs ->
11198 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11199 | CallInt i -> string_of_int i
11200 | CallInt64 i -> Int64.to_string i
11201 | CallBool b -> string_of_bool b
11202 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11207 generate_lang_bindtests (
11208 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11211 pr "print \"EOF\\n\"\n"
11213 and generate_java_bindtests () =
11214 generate_header CStyle GPLv2plus;
11217 import com.redhat.et.libguestfs.*;
11219 public class Bindtests {
11220 public static void main (String[] argv)
11223 GuestFS g = new GuestFS ();
11227 String.concat ", " (
11230 | CallString s -> "\"" ^ s ^ "\""
11231 | CallOptString None -> "null"
11232 | CallOptString (Some s) -> sprintf "\"%s\"" s
11233 | CallStringList xs ->
11235 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11236 | CallInt i -> string_of_int i
11237 | CallInt64 i -> Int64.to_string i
11238 | CallBool b -> string_of_bool b
11240 "new byte[] { " ^ String.concat "," (
11241 map_chars (fun c -> string_of_int (Char.code c)) s
11247 generate_lang_bindtests (
11248 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11252 System.out.println (\"EOF\");
11254 catch (Exception exn) {
11255 System.err.println (exn);
11262 and generate_haskell_bindtests () =
11263 generate_header HaskellStyle GPLv2plus;
11266 module Bindtests where
11267 import qualified Guestfs
11270 g <- Guestfs.create
11274 String.concat " " (
11277 | CallString s -> "\"" ^ s ^ "\""
11278 | CallOptString None -> "Nothing"
11279 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11280 | CallStringList xs ->
11281 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11282 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11283 | CallInt i -> string_of_int i
11284 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11285 | CallInt64 i -> Int64.to_string i
11286 | CallBool true -> "True"
11287 | CallBool false -> "False"
11288 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11293 generate_lang_bindtests (
11294 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11297 pr " putStrLn \"EOF\"\n"
11299 (* Language-independent bindings tests - we do it this way to
11300 * ensure there is parity in testing bindings across all languages.
11302 and generate_lang_bindtests call =
11303 call "test0" [CallString "abc"; CallOptString (Some "def");
11304 CallStringList []; CallBool false;
11305 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11306 CallBuffer "abc\000abc"];
11307 call "test0" [CallString "abc"; CallOptString None;
11308 CallStringList []; CallBool false;
11309 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11310 CallBuffer "abc\000abc"];
11311 call "test0" [CallString ""; CallOptString (Some "def");
11312 CallStringList []; CallBool false;
11313 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11314 CallBuffer "abc\000abc"];
11315 call "test0" [CallString ""; CallOptString (Some "");
11316 CallStringList []; CallBool false;
11317 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11318 CallBuffer "abc\000abc"];
11319 call "test0" [CallString "abc"; CallOptString (Some "def");
11320 CallStringList ["1"]; CallBool false;
11321 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11322 CallBuffer "abc\000abc"];
11323 call "test0" [CallString "abc"; CallOptString (Some "def");
11324 CallStringList ["1"; "2"]; CallBool false;
11325 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11326 CallBuffer "abc\000abc"];
11327 call "test0" [CallString "abc"; CallOptString (Some "def");
11328 CallStringList ["1"]; CallBool true;
11329 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11330 CallBuffer "abc\000abc"];
11331 call "test0" [CallString "abc"; CallOptString (Some "def");
11332 CallStringList ["1"]; CallBool false;
11333 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11334 CallBuffer "abc\000abc"];
11335 call "test0" [CallString "abc"; CallOptString (Some "def");
11336 CallStringList ["1"]; CallBool false;
11337 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11338 CallBuffer "abc\000abc"];
11339 call "test0" [CallString "abc"; CallOptString (Some "def");
11340 CallStringList ["1"]; CallBool false;
11341 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11342 CallBuffer "abc\000abc"];
11343 call "test0" [CallString "abc"; CallOptString (Some "def");
11344 CallStringList ["1"]; CallBool false;
11345 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11346 CallBuffer "abc\000abc"];
11347 call "test0" [CallString "abc"; CallOptString (Some "def");
11348 CallStringList ["1"]; CallBool false;
11349 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11350 CallBuffer "abc\000abc"];
11351 call "test0" [CallString "abc"; CallOptString (Some "def");
11352 CallStringList ["1"]; CallBool false;
11353 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11354 CallBuffer "abc\000abc"]
11356 (* XXX Add here tests of the return and error functions. *)
11358 (* Code to generator bindings for virt-inspector. Currently only
11359 * implemented for OCaml code (for virt-p2v 2.0).
11361 let rng_input = "inspector/virt-inspector.rng"
11363 (* Read the input file and parse it into internal structures. This is
11364 * by no means a complete RELAX NG parser, but is just enough to be
11365 * able to parse the specific input file.
11368 | Element of string * rng list (* <element name=name/> *)
11369 | Attribute of string * rng list (* <attribute name=name/> *)
11370 | Interleave of rng list (* <interleave/> *)
11371 | ZeroOrMore of rng (* <zeroOrMore/> *)
11372 | OneOrMore of rng (* <oneOrMore/> *)
11373 | Optional of rng (* <optional/> *)
11374 | Choice of string list (* <choice><value/>*</choice> *)
11375 | Value of string (* <value>str</value> *)
11376 | Text (* <text/> *)
11378 let rec string_of_rng = function
11379 | Element (name, xs) ->
11380 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11381 | Attribute (name, xs) ->
11382 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11383 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11384 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11385 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11386 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11387 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11388 | Value value -> "Value \"" ^ value ^ "\""
11391 and string_of_rng_list xs =
11392 String.concat ", " (List.map string_of_rng xs)
11394 let rec parse_rng ?defines context = function
11396 | Xml.Element ("element", ["name", name], children) :: rest ->
11397 Element (name, parse_rng ?defines context children)
11398 :: parse_rng ?defines context rest
11399 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11400 Attribute (name, parse_rng ?defines context children)
11401 :: parse_rng ?defines context rest
11402 | Xml.Element ("interleave", [], children) :: rest ->
11403 Interleave (parse_rng ?defines context children)
11404 :: parse_rng ?defines context rest
11405 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11406 let rng = parse_rng ?defines context [child] in
11408 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11410 failwithf "%s: <zeroOrMore> contains more than one child element"
11413 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11414 let rng = parse_rng ?defines context [child] in
11416 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11418 failwithf "%s: <oneOrMore> contains more than one child element"
11421 | Xml.Element ("optional", [], [child]) :: rest ->
11422 let rng = parse_rng ?defines context [child] in
11424 | [child] -> Optional child :: parse_rng ?defines context rest
11426 failwithf "%s: <optional> contains more than one child element"
11429 | Xml.Element ("choice", [], children) :: rest ->
11430 let values = List.map (
11431 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11433 failwithf "%s: can't handle anything except <value> in <choice>"
11437 :: parse_rng ?defines context rest
11438 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11439 Value value :: parse_rng ?defines context rest
11440 | Xml.Element ("text", [], []) :: rest ->
11441 Text :: parse_rng ?defines context rest
11442 | Xml.Element ("ref", ["name", name], []) :: rest ->
11443 (* Look up the reference. Because of limitations in this parser,
11444 * we can't handle arbitrarily nested <ref> yet. You can only
11445 * use <ref> from inside <start>.
11447 (match defines with
11449 failwithf "%s: contains <ref>, but no refs are defined yet" context
11451 let rng = StringMap.find name map in
11452 rng @ parse_rng ?defines context rest
11455 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11458 let xml = Xml.parse_file rng_input in
11460 | Xml.Element ("grammar", _,
11461 Xml.Element ("start", _, gram) :: defines) ->
11462 (* The <define/> elements are referenced in the <start> section,
11463 * so build a map of those first.
11465 let defines = List.fold_left (
11467 function Xml.Element ("define", ["name", name], defn) ->
11468 StringMap.add name defn map
11470 failwithf "%s: expected <define name=name/>" rng_input
11471 ) StringMap.empty defines in
11472 let defines = StringMap.mapi parse_rng defines in
11474 (* Parse the <start> clause, passing the defines. *)
11475 parse_rng ~defines "<start>" gram
11477 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11480 let name_of_field = function
11481 | Element (name, _) | Attribute (name, _)
11482 | ZeroOrMore (Element (name, _))
11483 | OneOrMore (Element (name, _))
11484 | Optional (Element (name, _)) -> name
11485 | Optional (Attribute (name, _)) -> name
11486 | Text -> (* an unnamed field in an element *)
11489 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11491 (* At the moment this function only generates OCaml types. However we
11492 * should parameterize it later so it can generate types/structs in a
11493 * variety of languages.
11495 let generate_types xs =
11496 (* A simple type is one that can be printed out directly, eg.
11497 * "string option". A complex type is one which has a name and has
11498 * to be defined via another toplevel definition, eg. a struct.
11500 * generate_type generates code for either simple or complex types.
11501 * In the simple case, it returns the string ("string option"). In
11502 * the complex case, it returns the name ("mountpoint"). In the
11503 * complex case it has to print out the definition before returning,
11504 * so it should only be called when we are at the beginning of a
11505 * new line (BOL context).
11507 let rec generate_type = function
11508 | Text -> (* string *)
11510 | Choice values -> (* [`val1|`val2|...] *)
11511 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11512 | ZeroOrMore rng -> (* <rng> list *)
11513 let t, is_simple = generate_type rng in
11514 t ^ " list (* 0 or more *)", is_simple
11515 | OneOrMore rng -> (* <rng> list *)
11516 let t, is_simple = generate_type rng in
11517 t ^ " list (* 1 or more *)", is_simple
11518 (* virt-inspector hack: bool *)
11519 | Optional (Attribute (name, [Value "1"])) ->
11521 | Optional rng -> (* <rng> list *)
11522 let t, is_simple = generate_type rng in
11523 t ^ " option", is_simple
11524 (* type name = { fields ... } *)
11525 | Element (name, fields) when is_attrs_interleave fields ->
11526 generate_type_struct name (get_attrs_interleave fields)
11527 | Element (name, [field]) (* type name = field *)
11528 | Attribute (name, [field]) ->
11529 let t, is_simple = generate_type field in
11530 if is_simple then (t, true)
11532 pr "type %s = %s\n" name t;
11535 | Element (name, fields) -> (* type name = { fields ... } *)
11536 generate_type_struct name fields
11538 failwithf "generate_type failed at: %s" (string_of_rng rng)
11540 and is_attrs_interleave = function
11541 | [Interleave _] -> true
11542 | Attribute _ :: fields -> is_attrs_interleave fields
11543 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11546 and get_attrs_interleave = function
11547 | [Interleave fields] -> fields
11548 | ((Attribute _) as field) :: fields
11549 | ((Optional (Attribute _)) as field) :: fields ->
11550 field :: get_attrs_interleave fields
11551 | _ -> assert false
11553 and generate_types xs =
11554 List.iter (fun x -> ignore (generate_type x)) xs
11556 and generate_type_struct name fields =
11557 (* Calculate the types of the fields first. We have to do this
11558 * before printing anything so we are still in BOL context.
11560 let types = List.map fst (List.map generate_type fields) in
11562 (* Special case of a struct containing just a string and another
11563 * field. Turn it into an assoc list.
11566 | ["string"; other] ->
11567 let fname1, fname2 =
11569 | [f1; f2] -> name_of_field f1, name_of_field f2
11570 | _ -> assert false in
11571 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11575 pr "type %s = {\n" name;
11577 fun (field, ftype) ->
11578 let fname = name_of_field field in
11579 pr " %s_%s : %s;\n" name fname ftype
11580 ) (List.combine fields types);
11582 (* Return the name of this type, and
11583 * false because it's not a simple type.
11590 let generate_parsers xs =
11591 (* As for generate_type above, generate_parser makes a parser for
11592 * some type, and returns the name of the parser it has generated.
11593 * Because it (may) need to print something, it should always be
11594 * called in BOL context.
11596 let rec generate_parser = function
11597 | Text -> (* string *)
11598 "string_child_or_empty"
11599 | Choice values -> (* [`val1|`val2|...] *)
11600 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11602 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11603 | ZeroOrMore rng -> (* <rng> list *)
11604 let pa = generate_parser rng in
11605 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11606 | OneOrMore rng -> (* <rng> list *)
11607 let pa = generate_parser rng in
11608 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11609 (* virt-inspector hack: bool *)
11610 | Optional (Attribute (name, [Value "1"])) ->
11611 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11612 | Optional rng -> (* <rng> list *)
11613 let pa = generate_parser rng in
11614 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11615 (* type name = { fields ... } *)
11616 | Element (name, fields) when is_attrs_interleave fields ->
11617 generate_parser_struct name (get_attrs_interleave fields)
11618 | Element (name, [field]) -> (* type name = field *)
11619 let pa = generate_parser field in
11620 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11621 pr "let %s =\n" parser_name;
11623 pr "let parse_%s = %s\n" name parser_name;
11625 | Attribute (name, [field]) ->
11626 let pa = generate_parser field in
11627 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11628 pr "let %s =\n" parser_name;
11630 pr "let parse_%s = %s\n" name parser_name;
11632 | Element (name, fields) -> (* type name = { fields ... } *)
11633 generate_parser_struct name ([], fields)
11635 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11637 and is_attrs_interleave = function
11638 | [Interleave _] -> true
11639 | Attribute _ :: fields -> is_attrs_interleave fields
11640 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11643 and get_attrs_interleave = function
11644 | [Interleave fields] -> [], fields
11645 | ((Attribute _) as field) :: fields
11646 | ((Optional (Attribute _)) as field) :: fields ->
11647 let attrs, interleaves = get_attrs_interleave fields in
11648 (field :: attrs), interleaves
11649 | _ -> assert false
11651 and generate_parsers xs =
11652 List.iter (fun x -> ignore (generate_parser x)) xs
11654 and generate_parser_struct name (attrs, interleaves) =
11655 (* Generate parsers for the fields first. We have to do this
11656 * before printing anything so we are still in BOL context.
11658 let fields = attrs @ interleaves in
11659 let pas = List.map generate_parser fields in
11661 (* Generate an intermediate tuple from all the fields first.
11662 * If the type is just a string + another field, then we will
11663 * return this directly, otherwise it is turned into a record.
11665 * RELAX NG note: This code treats <interleave> and plain lists of
11666 * fields the same. In other words, it doesn't bother enforcing
11667 * any ordering of fields in the XML.
11669 pr "let parse_%s x =\n" name;
11670 pr " let t = (\n ";
11671 let comma = ref false in
11674 if !comma then pr ",\n ";
11677 | Optional (Attribute (fname, [field])), pa ->
11679 | Optional (Element (fname, [field])), pa ->
11680 pr "%s (optional_child %S x)" pa fname
11681 | Attribute (fname, [Text]), _ ->
11682 pr "attribute %S x" fname
11683 | (ZeroOrMore _ | OneOrMore _), pa ->
11688 let fname = name_of_field field in
11689 pr "%s (child %S x)" pa fname
11690 ) (List.combine fields pas);
11694 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11698 pr " (Obj.magic t : %s)\n" name
11702 | (Optional (Attribute (fname, [field])), pa) ->
11703 pr " %s_%s =\n" name fname;
11705 | (Optional (Element (fname, [field])), pa) ->
11706 pr " %s_%s =\n" name fname;
11707 pr " (let x = optional_child %S x in\n" fname;
11710 let fname = name_of_field field in
11711 pr " %s_%s =\n" name fname;
11712 pr " (let x = child %S x in\n" fname;
11714 ) (List.combine fields pas);
11718 sprintf "parse_%s" name
11721 generate_parsers xs
11723 (* Generate ocaml/guestfs_inspector.mli. *)
11724 let generate_ocaml_inspector_mli () =
11725 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11728 (** This is an OCaml language binding to the external [virt-inspector]
11731 For more information, please read the man page [virt-inspector(1)].
11736 generate_types grammar;
11737 pr "(** The nested information returned from the {!inspect} function. *)\n";
11741 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11742 (** To inspect a libvirt domain called [name], pass a singleton
11743 list: [inspect [name]]. When using libvirt only, you may
11744 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11746 To inspect a disk image or images, pass a list of the filenames
11747 of the disk images: [inspect filenames]
11749 This function inspects the given guest or disk images and
11750 returns a list of operating system(s) found and a large amount
11751 of information about them. In the vast majority of cases,
11752 a virtual machine only contains a single operating system.
11754 If the optional [~xml] parameter is given, then this function
11755 skips running the external virt-inspector program and just
11756 parses the given XML directly (which is expected to be XML
11757 produced from a previous run of virt-inspector). The list of
11758 names and connect URI are ignored in this case.
11760 This function can throw a wide variety of exceptions, for example
11761 if the external virt-inspector program cannot be found, or if
11762 it doesn't generate valid XML.
11766 (* Generate ocaml/guestfs_inspector.ml. *)
11767 let generate_ocaml_inspector_ml () =
11768 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11773 generate_types grammar;
11777 (* Misc functions which are used by the parser code below. *)
11778 let first_child = function
11779 | Xml.Element (_, _, c::_) -> c
11780 | Xml.Element (name, _, []) ->
11781 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11782 | Xml.PCData str ->
11783 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11785 let string_child_or_empty = function
11786 | Xml.Element (_, _, [Xml.PCData s]) -> s
11787 | Xml.Element (_, _, []) -> \"\"
11788 | Xml.Element (x, _, _) ->
11789 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11791 | Xml.PCData str ->
11792 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11794 let optional_child name xml =
11795 let children = Xml.children xml in
11797 Some (List.find (function
11798 | Xml.Element (n, _, _) when n = name -> true
11799 | _ -> false) children)
11803 let child name xml =
11804 match optional_child name xml with
11807 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11809 let attribute name xml =
11810 try Xml.attrib xml name
11811 with Xml.No_attribute _ ->
11812 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11816 generate_parsers grammar;
11820 (* Run external virt-inspector, then use parser to parse the XML. *)
11821 let inspect ?connect ?xml names =
11825 if names = [] then invalid_arg \"inspect: no names given\";
11826 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11827 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11829 let cmd = List.map Filename.quote cmd in
11830 let cmd = String.concat \" \" cmd in
11831 let chan = open_process_in cmd in
11832 let xml = Xml.parse_in chan in
11833 (match close_process_in chan with
11835 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11836 | WSIGNALED i | WSTOPPED i ->
11837 failwith (\"external virt-inspector command died or stopped on sig \" ^
11842 Xml.parse_string doc in
11843 parse_operatingsystems xml
11846 and generate_max_proc_nr () =
11847 pr "%d\n" max_proc_nr
11849 let output_to filename k =
11850 let filename_new = filename ^ ".new" in
11851 chan := open_out filename_new;
11854 chan := Pervasives.stdout;
11856 (* Is the new file different from the current file? *)
11857 if Sys.file_exists filename && files_equal filename filename_new then
11858 unlink filename_new (* same, so skip it *)
11860 (* different, overwrite old one *)
11861 (try chmod filename 0o644 with Unix_error _ -> ());
11862 rename filename_new filename;
11863 chmod filename 0o444;
11864 printf "written %s\n%!" filename;
11867 let perror msg = function
11868 | Unix_error (err, _, _) ->
11869 eprintf "%s: %s\n" msg (error_message err)
11871 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11873 (* Main program. *)
11876 try openfile "HACKING" [O_RDWR] 0
11878 | Unix_error (ENOENT, _, _) ->
11880 You are probably running this from the wrong directory.
11881 Run it from the top source directory using the command
11886 perror "open: HACKING" exn;
11889 (* Acquire a lock so parallel builds won't try to run the generator
11890 * twice at the same time. Subsequent builds will wait for the first
11891 * one to finish. Note the lock is released implicitly when the
11894 (try lockf lock_fd F_LOCK 1
11896 perror "lock: HACKING" exn;
11899 check_functions ();
11901 output_to "src/guestfs_protocol.x" generate_xdr;
11902 output_to "src/guestfs-structs.h" generate_structs_h;
11903 output_to "src/guestfs-actions.h" generate_actions_h;
11904 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11905 output_to "src/guestfs-actions.c" generate_client_actions;
11906 output_to "src/guestfs-bindtests.c" generate_bindtests;
11907 output_to "src/guestfs-structs.pod" generate_structs_pod;
11908 output_to "src/guestfs-actions.pod" generate_actions_pod;
11909 output_to "src/guestfs-availability.pod" generate_availability_pod;
11910 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11911 output_to "src/libguestfs.syms" generate_linker_script;
11912 output_to "daemon/actions.h" generate_daemon_actions_h;
11913 output_to "daemon/stubs.c" generate_daemon_actions;
11914 output_to "daemon/names.c" generate_daemon_names;
11915 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11916 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11917 output_to "capitests/tests.c" generate_tests;
11918 output_to "fish/cmds.c" generate_fish_cmds;
11919 output_to "fish/completion.c" generate_fish_completion;
11920 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11921 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11922 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11923 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11924 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11925 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11926 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11927 output_to "perl/Guestfs.xs" generate_perl_xs;
11928 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11929 output_to "perl/bindtests.pl" generate_perl_bindtests;
11930 output_to "python/guestfs-py.c" generate_python_c;
11931 output_to "python/guestfs.py" generate_python_py;
11932 output_to "python/bindtests.py" generate_python_bindtests;
11933 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
11934 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
11935 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
11939 let cols = cols_of_struct typ in
11940 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
11941 output_to filename (generate_java_struct jtyp cols);
11944 output_to "java/Makefile.inc" generate_java_makefile_inc;
11945 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
11946 output_to "java/Bindtests.java" generate_java_bindtests;
11947 output_to "haskell/Guestfs.hs" generate_haskell_hs;
11948 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
11949 output_to "csharp/Libguestfs.cs" generate_csharp;
11951 (* Always generate this file last, and unconditionally. It's used
11952 * by the Makefile to know when we must re-run the generator.
11954 let chan = open_out "src/stamp-generator" in
11955 fprintf chan "1\n";
11958 printf "generated %d lines of code\n" !lines