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, [Optional "xz"],
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, [Optional "xz"],
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>.");
4689 ("resize2fs_size", (RErr, [Device "device"; Int64 "size"]), 248, [],
4691 "resize an ext2/ext3 filesystem (with size)",
4693 This command is the same as C<guestfs_resize2fs> except that it
4694 allows you to specify the new size (in bytes) explicitly.");
4696 ("pvresize_size", (RErr, [Device "device"; Int64 "size"]), 249, [Optional "lvm2"],
4698 "resize an LVM physical volume (with size)",
4700 This command is the same as C<guestfs_pvresize> except that it
4701 allows you to specify the new size (in bytes) explicitly.");
4703 ("ntfsresize_size", (RErr, [Device "device"; Int64 "size"]), 250, [Optional "ntfsprogs"],
4705 "resize an NTFS filesystem (with size)",
4707 This command is the same as C<guestfs_ntfsresize> except that it
4708 allows you to specify the new size (in bytes) explicitly.");
4712 let all_functions = non_daemon_functions @ daemon_functions
4714 (* In some places we want the functions to be displayed sorted
4715 * alphabetically, so this is useful:
4717 let all_functions_sorted =
4718 List.sort (fun (n1,_,_,_,_,_,_) (n2,_,_,_,_,_,_) ->
4719 compare n1 n2) all_functions
4721 (* This is used to generate the src/MAX_PROC_NR file which
4722 * contains the maximum procedure number, a surrogate for the
4723 * ABI version number. See src/Makefile.am for the details.
4726 let proc_nrs = List.map (
4727 fun (_, _, proc_nr, _, _, _, _) -> proc_nr
4728 ) daemon_functions in
4729 List.fold_left max 0 proc_nrs
4731 (* Field types for structures. *)
4733 | FChar (* C 'char' (really, a 7 bit byte). *)
4734 | FString (* nul-terminated ASCII string, NOT NULL. *)
4735 | FBuffer (* opaque buffer of bytes, (char *, int) pair *)
4740 | FBytes (* Any int measure that counts bytes. *)
4741 | FUUID (* 32 bytes long, NOT nul-terminated. *)
4742 | FOptPercent (* [0..100], or -1 meaning "not present". *)
4744 (* Because we generate extra parsing code for LVM command line tools,
4745 * we have to pull out the LVM columns separately here.
4755 "pv_attr", FString (* XXX *);
4756 "pv_pe_count", FInt64;
4757 "pv_pe_alloc_count", FInt64;
4760 "pv_mda_count", FInt64;
4761 "pv_mda_free", FBytes;
4762 (* Not in Fedora 10:
4763 "pv_mda_size", FBytes;
4770 "vg_attr", FString (* XXX *);
4773 "vg_sysid", FString;
4774 "vg_extent_size", FBytes;
4775 "vg_extent_count", FInt64;
4776 "vg_free_count", FInt64;
4781 "snap_count", FInt64;
4784 "vg_mda_count", FInt64;
4785 "vg_mda_free", FBytes;
4786 (* Not in Fedora 10:
4787 "vg_mda_size", FBytes;
4793 "lv_attr", FString (* XXX *);
4796 "lv_kernel_major", FInt64;
4797 "lv_kernel_minor", FInt64;
4799 "seg_count", FInt64;
4801 "snap_percent", FOptPercent;
4802 "copy_percent", FOptPercent;
4805 "mirror_log", FString;
4809 (* Names and fields in all structures (in RStruct and RStructList)
4813 (* The old RIntBool return type, only ever used for aug_defnode. Do
4814 * not use this struct in any new code.
4817 "i", FInt32; (* for historical compatibility *)
4818 "b", FInt32; (* for historical compatibility *)
4821 (* LVM PVs, VGs, LVs. *)
4822 "lvm_pv", lvm_pv_cols;
4823 "lvm_vg", lvm_vg_cols;
4824 "lvm_lv", lvm_lv_cols;
4826 (* Column names and types from stat structures.
4827 * NB. Can't use things like 'st_atime' because glibc header files
4828 * define some of these as macros. Ugh.
4859 (* Column names in dirent structure. *)
4862 (* 'b' 'c' 'd' 'f' (FIFO) 'l' 'r' (regular file) 's' 'u' '?' *)
4867 (* Version numbers. *)
4875 (* Extended attribute. *)
4877 "attrname", FString;
4881 (* Inotify events. *)
4885 "in_cookie", FUInt32;
4889 (* Partition table entry. *)
4892 "part_start", FBytes;
4894 "part_size", FBytes;
4896 ] (* end of structs *)
4898 (* Ugh, Java has to be different ..
4899 * These names are also used by the Haskell bindings.
4901 let java_structs = [
4902 "int_bool", "IntBool";
4907 "statvfs", "StatVFS";
4909 "version", "Version";
4911 "inotify_event", "INotifyEvent";
4912 "partition", "Partition";
4915 (* What structs are actually returned. *)
4916 type rstructs_used_t = RStructOnly | RStructListOnly | RStructAndList
4918 (* Returns a list of RStruct/RStructList structs that are returned
4919 * by any function. Each element of returned list is a pair:
4921 * (structname, RStructOnly)
4922 * == there exists function which returns RStruct (_, structname)
4923 * (structname, RStructListOnly)
4924 * == there exists function which returns RStructList (_, structname)
4925 * (structname, RStructAndList)
4926 * == there are functions returning both RStruct (_, structname)
4927 * and RStructList (_, structname)
4929 let rstructs_used_by functions =
4930 (* ||| is a "logical OR" for rstructs_used_t *)
4934 | _, RStructAndList -> RStructAndList
4935 | RStructOnly, RStructListOnly
4936 | RStructListOnly, RStructOnly -> RStructAndList
4937 | RStructOnly, RStructOnly -> RStructOnly
4938 | RStructListOnly, RStructListOnly -> RStructListOnly
4941 let h = Hashtbl.create 13 in
4943 (* if elem->oldv exists, update entry using ||| operator,
4944 * else just add elem->newv to the hash
4946 let update elem newv =
4947 try let oldv = Hashtbl.find h elem in
4948 Hashtbl.replace h elem (newv ||| oldv)
4949 with Not_found -> Hashtbl.add h elem newv
4953 fun (_, style, _, _, _, _, _) ->
4954 match fst style with
4955 | RStruct (_, structname) -> update structname RStructOnly
4956 | RStructList (_, structname) -> update structname RStructListOnly
4960 (* return key->values as a list of (key,value) *)
4961 Hashtbl.fold (fun key value xs -> (key, value) :: xs) h []
4963 (* Used for testing language bindings. *)
4965 | CallString of string
4966 | CallOptString of string option
4967 | CallStringList of string list
4969 | CallInt64 of int64
4971 | CallBuffer of string
4973 (* Used to memoize the result of pod2text. *)
4974 let pod2text_memo_filename = "src/.pod2text.data"
4975 let pod2text_memo : ((int * string * string), string list) Hashtbl.t =
4977 let chan = open_in pod2text_memo_filename in
4978 let v = input_value chan in
4982 _ -> Hashtbl.create 13
4983 let pod2text_memo_updated () =
4984 let chan = open_out pod2text_memo_filename in
4985 output_value chan pod2text_memo;
4988 (* Useful functions.
4989 * Note we don't want to use any external OCaml libraries which
4990 * makes this a bit harder than it should be.
4992 module StringMap = Map.Make (String)
4994 let failwithf fs = ksprintf failwith fs
4996 let unique = let i = ref 0 in fun () -> incr i; !i
4998 let replace_char s c1 c2 =
4999 let s2 = String.copy s in
5000 let r = ref false in
5001 for i = 0 to String.length s2 - 1 do
5002 if String.unsafe_get s2 i = c1 then (
5003 String.unsafe_set s2 i c2;
5007 if not !r then s else s2
5011 (* || c = '\f' *) || c = '\n' || c = '\r' || c = '\t' (* || c = '\v' *)
5013 let triml ?(test = isspace) str =
5015 let n = ref (String.length str) in
5016 while !n > 0 && test str.[!i]; do
5021 else String.sub str !i !n
5023 let trimr ?(test = isspace) str =
5024 let n = ref (String.length str) in
5025 while !n > 0 && test str.[!n-1]; do
5028 if !n = String.length str then str
5029 else String.sub str 0 !n
5031 let trim ?(test = isspace) str =
5032 trimr ~test (triml ~test str)
5034 let rec find s sub =
5035 let len = String.length s in
5036 let sublen = String.length sub in
5038 if i <= len-sublen then (
5040 if j < sublen then (
5041 if s.[i+j] = sub.[j] then loop2 (j+1)
5047 if r = -1 then loop (i+1) else r
5053 let rec replace_str s s1 s2 =
5054 let len = String.length s in
5055 let sublen = String.length s1 in
5056 let i = find s s1 in
5059 let s' = String.sub s 0 i in
5060 let s'' = String.sub s (i+sublen) (len-i-sublen) in
5061 s' ^ s2 ^ replace_str s'' s1 s2
5064 let rec string_split sep str =
5065 let len = String.length str in
5066 let seplen = String.length sep in
5067 let i = find str sep in
5068 if i = -1 then [str]
5070 let s' = String.sub str 0 i in
5071 let s'' = String.sub str (i+seplen) (len-i-seplen) in
5072 s' :: string_split sep s''
5075 let files_equal n1 n2 =
5076 let cmd = sprintf "cmp -s %s %s" (Filename.quote n1) (Filename.quote n2) in
5077 match Sys.command cmd with
5080 | i -> failwithf "%s: failed with error code %d" cmd i
5082 let rec filter_map f = function
5086 | Some y -> y :: filter_map f xs
5087 | None -> filter_map f xs
5089 let rec find_map f = function
5090 | [] -> raise Not_found
5094 | None -> find_map f xs
5097 let rec loop i = function
5099 | x :: xs -> f i x; loop (i+1) xs
5104 let rec loop i = function
5106 | x :: xs -> let r = f i x in r :: loop (i+1) xs
5110 let count_chars c str =
5111 let count = ref 0 in
5112 for i = 0 to String.length str - 1 do
5113 if c = String.unsafe_get str i then incr count
5119 for i = 0 to String.length str - 1 do
5120 let c = String.unsafe_get str i in
5125 let map_chars f str =
5126 List.map f (explode str)
5128 let name_of_argt = function
5129 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
5130 | StringList n | DeviceList n | Bool n | Int n | Int64 n
5131 | FileIn n | FileOut n | BufferIn n -> n
5133 let java_name_of_struct typ =
5134 try List.assoc typ java_structs
5137 "java_name_of_struct: no java_structs entry corresponding to %s" typ
5139 let cols_of_struct typ =
5140 try List.assoc typ structs
5142 failwithf "cols_of_struct: unknown struct %s" typ
5144 let seq_of_test = function
5145 | TestRun s | TestOutput (s, _) | TestOutputList (s, _)
5146 | TestOutputListOfDevices (s, _)
5147 | TestOutputInt (s, _) | TestOutputIntOp (s, _, _)
5148 | TestOutputTrue s | TestOutputFalse s
5149 | TestOutputLength (s, _) | TestOutputBuffer (s, _)
5150 | TestOutputStruct (s, _)
5151 | TestLastFail s -> s
5153 (* Handling for function flags. *)
5154 let protocol_limit_warning =
5155 "Because of the message protocol, there is a transfer limit
5156 of somewhere between 2MB and 4MB. See L<guestfs(3)/PROTOCOL LIMITS>."
5158 let danger_will_robinson =
5159 "B<This command is dangerous. Without careful use you
5160 can easily destroy all your data>."
5162 let deprecation_notice flags =
5165 find_map (function DeprecatedBy str -> Some str | _ -> None) flags in
5167 sprintf "This function is deprecated.
5168 In new code, use the C<%s> call instead.
5170 Deprecated functions will not be removed from the API, but the
5171 fact that they are deprecated indicates that there are problems
5172 with correct use of these functions." alt in
5177 (* Create list of optional groups. *)
5179 let h = Hashtbl.create 13 in
5181 fun (name, _, _, flags, _, _, _) ->
5185 let names = try Hashtbl.find h group with Not_found -> [] in
5186 Hashtbl.replace h group (name :: names)
5190 let groups = Hashtbl.fold (fun k _ ks -> k :: ks) h [] in
5193 fun group -> group, List.sort compare (Hashtbl.find h group)
5195 List.sort (fun x y -> compare (fst x) (fst y)) groups
5197 (* Check function names etc. for consistency. *)
5198 let check_functions () =
5199 let contains_uppercase str =
5200 let len = String.length str in
5202 if i >= len then false
5205 if c >= 'A' && c <= 'Z' then true
5212 (* Check function names. *)
5214 fun (name, _, _, _, _, _, _) ->
5215 if String.length name >= 7 && String.sub name 0 7 = "guestfs" then
5216 failwithf "function name %s does not need 'guestfs' prefix" name;
5218 failwithf "function name is empty";
5219 if name.[0] < 'a' || name.[0] > 'z' then
5220 failwithf "function name %s must start with lowercase a-z" name;
5221 if String.contains name '-' then
5222 failwithf "function name %s should not contain '-', use '_' instead."
5226 (* Check function parameter/return names. *)
5228 fun (name, style, _, _, _, _, _) ->
5229 let check_arg_ret_name n =
5230 if contains_uppercase n then
5231 failwithf "%s param/ret %s should not contain uppercase chars"
5233 if String.contains n '-' || String.contains n '_' then
5234 failwithf "%s param/ret %s should not contain '-' or '_'"
5237 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;
5238 if n = "int" || n = "char" || n = "short" || n = "long" then
5239 failwithf "%s has a param/ret which conflicts with a C type (eg. 'int', 'char' etc.)" name;
5240 if n = "i" || n = "n" then
5241 failwithf "%s has a param/ret called 'i' or 'n', which will cause some conflicts in the generated code" name;
5242 if n = "argv" || n = "args" then
5243 failwithf "%s has a param/ret called 'argv' or 'args', which will cause some conflicts in the generated code" name;
5245 (* List Haskell, OCaml and C keywords here.
5246 * http://www.haskell.org/haskellwiki/Keywords
5247 * http://caml.inria.fr/pub/docs/manual-ocaml/lex.html#operator-char
5248 * http://en.wikipedia.org/wiki/C_syntax#Reserved_keywords
5249 * Formatted via: cat c haskell ocaml|sort -u|grep -vE '_|^val$' \
5250 * |perl -pe 's/(.+)/"$1";/'|fmt -70
5251 * Omitting _-containing words, since they're handled above.
5252 * Omitting the OCaml reserved word, "val", is ok,
5253 * and saves us from renaming several parameters.
5256 "and"; "as"; "asr"; "assert"; "auto"; "begin"; "break"; "case";
5257 "char"; "class"; "const"; "constraint"; "continue"; "data";
5258 "default"; "deriving"; "do"; "done"; "double"; "downto"; "else";
5259 "end"; "enum"; "exception"; "extern"; "external"; "false"; "float";
5260 "for"; "forall"; "foreign"; "fun"; "function"; "functor"; "goto";
5261 "hiding"; "if"; "import"; "in"; "include"; "infix"; "infixl";
5262 "infixr"; "inherit"; "initializer"; "inline"; "instance"; "int";
5264 "land"; "lazy"; "let"; "long"; "lor"; "lsl"; "lsr"; "lxor";
5265 "match"; "mdo"; "method"; "mod"; "module"; "mutable"; "new";
5266 "newtype"; "object"; "of"; "open"; "or"; "private"; "qualified";
5267 "rec"; "register"; "restrict"; "return"; "short"; "sig"; "signed";
5268 "sizeof"; "static"; "struct"; "switch"; "then"; "to"; "true"; "try";
5269 "type"; "typedef"; "union"; "unsigned"; "virtual"; "void";
5270 "volatile"; "when"; "where"; "while";
5272 if List.mem n reserved then
5273 failwithf "%s has param/ret using reserved word %s" name n;
5276 (match fst style with
5278 | RInt n | RInt64 n | RBool n
5279 | RConstString n | RConstOptString n | RString n
5280 | RStringList n | RStruct (n, _) | RStructList (n, _)
5281 | RHashtable n | RBufferOut n ->
5282 check_arg_ret_name n
5284 List.iter (fun arg -> check_arg_ret_name (name_of_argt arg)) (snd style)
5287 (* Check short descriptions. *)
5289 fun (name, _, _, _, _, shortdesc, _) ->
5290 if shortdesc.[0] <> Char.lowercase shortdesc.[0] then
5291 failwithf "short description of %s should begin with lowercase." name;
5292 let c = shortdesc.[String.length shortdesc-1] in
5293 if c = '\n' || c = '.' then
5294 failwithf "short description of %s should not end with . or \\n." name
5297 (* Check long descriptions. *)
5299 fun (name, _, _, _, _, _, longdesc) ->
5300 if longdesc.[String.length longdesc-1] = '\n' then
5301 failwithf "long description of %s should not end with \\n." name
5304 (* Check proc_nrs. *)
5306 fun (name, _, proc_nr, _, _, _, _) ->
5307 if proc_nr <= 0 then
5308 failwithf "daemon function %s should have proc_nr > 0" name
5312 fun (name, _, proc_nr, _, _, _, _) ->
5313 if proc_nr <> -1 then
5314 failwithf "non-daemon function %s should have proc_nr -1" name
5315 ) non_daemon_functions;
5318 List.map (fun (name, _, proc_nr, _, _, _, _) -> name, proc_nr)
5321 List.sort (fun (_,nr1) (_,nr2) -> compare nr1 nr2) proc_nrs in
5322 let rec loop = function
5325 | (name1,nr1) :: ((name2,nr2) :: _ as rest) when nr1 < nr2 ->
5327 | (name1,nr1) :: (name2,nr2) :: _ ->
5328 failwithf "%s and %s have conflicting procedure numbers (%d, %d)"
5336 (* Ignore functions that have no tests. We generate a
5337 * warning when the user does 'make check' instead.
5339 | name, _, _, _, [], _, _ -> ()
5340 | name, _, _, _, tests, _, _ ->
5344 match seq_of_test test with
5346 failwithf "%s has a test containing an empty sequence" name
5347 | cmds -> List.map List.hd cmds
5349 let funcs = List.flatten funcs in
5351 let tested = List.mem name funcs in
5354 failwithf "function %s has tests but does not test itself" name
5357 (* 'pr' prints to the current output file. *)
5358 let chan = ref Pervasives.stdout
5363 let i = count_chars '\n' str in
5364 lines := !lines + i;
5365 output_string !chan str
5368 let copyright_years =
5369 let this_year = 1900 + (localtime (time ())).tm_year in
5370 if this_year > 2009 then sprintf "2009-%04d" this_year else "2009"
5372 (* Generate a header block in a number of standard styles. *)
5373 type comment_style =
5374 CStyle | CPlusPlusStyle | HashStyle | OCamlStyle | HaskellStyle
5375 type license = GPLv2plus | LGPLv2plus
5377 let generate_header ?(extra_inputs = []) comment license =
5378 let inputs = "src/generator.ml" :: extra_inputs in
5379 let c = match comment with
5380 | CStyle -> pr "/* "; " *"
5381 | CPlusPlusStyle -> pr "// "; "//"
5382 | HashStyle -> pr "# "; "#"
5383 | OCamlStyle -> pr "(* "; " *"
5384 | HaskellStyle -> pr "{- "; " " in
5385 pr "libguestfs generated file\n";
5386 pr "%s WARNING: THIS FILE IS GENERATED FROM:\n" c;
5387 List.iter (pr "%s %s\n" c) inputs;
5388 pr "%s ANY CHANGES YOU MAKE TO THIS FILE WILL BE LOST.\n" c;
5390 pr "%s Copyright (C) %s Red Hat Inc.\n" c copyright_years;
5394 pr "%s This program is free software; you can redistribute it and/or modify\n" c;
5395 pr "%s it under the terms of the GNU General Public License as published by\n" c;
5396 pr "%s the Free Software Foundation; either version 2 of the License, or\n" c;
5397 pr "%s (at your option) any later version.\n" c;
5399 pr "%s This program is distributed in the hope that it will be useful,\n" c;
5400 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5401 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n" c;
5402 pr "%s GNU General Public License for more details.\n" c;
5404 pr "%s You should have received a copy of the GNU General Public License along\n" c;
5405 pr "%s with this program; if not, write to the Free Software Foundation, Inc.,\n" c;
5406 pr "%s 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.\n" c;
5409 pr "%s This library is free software; you can redistribute it and/or\n" c;
5410 pr "%s modify it under the terms of the GNU Lesser General Public\n" c;
5411 pr "%s License as published by the Free Software Foundation; either\n" c;
5412 pr "%s version 2 of the License, or (at your option) any later version.\n" c;
5414 pr "%s This library is distributed in the hope that it will be useful,\n" c;
5415 pr "%s but WITHOUT ANY WARRANTY; without even the implied warranty of\n" c;
5416 pr "%s MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n" c;
5417 pr "%s Lesser General Public License for more details.\n" c;
5419 pr "%s You should have received a copy of the GNU Lesser General Public\n" c;
5420 pr "%s License along with this library; if not, write to the Free Software\n" c;
5421 pr "%s Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA\n" c;
5424 | CStyle -> pr " */\n"
5427 | OCamlStyle -> pr " *)\n"
5428 | HaskellStyle -> pr "-}\n"
5432 (* Start of main code generation functions below this line. *)
5434 (* Generate the pod documentation for the C API. *)
5435 let rec generate_actions_pod () =
5437 fun (shortname, style, _, flags, _, _, longdesc) ->
5438 if not (List.mem NotInDocs flags) then (
5439 let name = "guestfs_" ^ shortname in
5440 pr "=head2 %s\n\n" name;
5442 generate_prototype ~extern:false ~handle:"g" name style;
5444 pr "%s\n\n" longdesc;
5445 (match fst style with
5447 pr "This function returns 0 on success or -1 on error.\n\n"
5449 pr "On error this function returns -1.\n\n"
5451 pr "On error this function returns -1.\n\n"
5453 pr "This function returns a C truth value on success or -1 on error.\n\n"
5455 pr "This function returns a string, or NULL on error.
5456 The string is owned by the guest handle and must I<not> be freed.\n\n"
5457 | RConstOptString _ ->
5458 pr "This function returns a string which may be NULL.
5459 There is way to return an error from this function.
5460 The string is owned by the guest handle and must I<not> be freed.\n\n"
5462 pr "This function returns a string, or NULL on error.
5463 I<The caller must free the returned string after use>.\n\n"
5465 pr "This function returns a NULL-terminated array of strings
5466 (like L<environ(3)>), or NULL if there was an error.
5467 I<The caller must free the strings and the array after use>.\n\n"
5468 | RStruct (_, typ) ->
5469 pr "This function returns a C<struct guestfs_%s *>,
5470 or NULL if there was an error.
5471 I<The caller must call C<guestfs_free_%s> after use>.\n\n" typ typ
5472 | RStructList (_, typ) ->
5473 pr "This function returns a C<struct guestfs_%s_list *>
5474 (see E<lt>guestfs-structs.hE<gt>),
5475 or NULL if there was an error.
5476 I<The caller must call C<guestfs_free_%s_list> after use>.\n\n" typ typ
5478 pr "This function returns a NULL-terminated array of
5479 strings, or NULL if there was an error.
5480 The array of strings will always have length C<2n+1>, where
5481 C<n> keys and values alternate, followed by the trailing NULL entry.
5482 I<The caller must free the strings and the array after use>.\n\n"
5484 pr "This function returns a buffer, or NULL on error.
5485 The size of the returned buffer is written to C<*size_r>.
5486 I<The caller must free the returned buffer after use>.\n\n"
5488 if List.mem ProtocolLimitWarning flags then
5489 pr "%s\n\n" protocol_limit_warning;
5490 if List.mem DangerWillRobinson flags then
5491 pr "%s\n\n" danger_will_robinson;
5492 match deprecation_notice flags with
5494 | Some txt -> pr "%s\n\n" txt
5496 ) all_functions_sorted
5498 and generate_structs_pod () =
5499 (* Structs documentation. *)
5502 pr "=head2 guestfs_%s\n" typ;
5504 pr " struct guestfs_%s {\n" typ;
5507 | name, FChar -> pr " char %s;\n" name
5508 | name, FUInt32 -> pr " uint32_t %s;\n" name
5509 | name, FInt32 -> pr " int32_t %s;\n" name
5510 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5511 | name, FInt64 -> pr " int64_t %s;\n" name
5512 | name, FString -> pr " char *%s;\n" name
5514 pr " /* The next two fields describe a byte array. */\n";
5515 pr " uint32_t %s_len;\n" name;
5516 pr " char *%s;\n" name
5518 pr " /* The next field is NOT nul-terminated, be careful when printing it: */\n";
5519 pr " char %s[32];\n" name
5520 | name, FOptPercent ->
5521 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
5522 pr " float %s;\n" name
5526 pr " struct guestfs_%s_list {\n" typ;
5527 pr " uint32_t len; /* Number of elements in list. */\n";
5528 pr " struct guestfs_%s *val; /* Elements. */\n" typ;
5531 pr " void guestfs_free_%s (struct guestfs_free_%s *);\n" typ typ;
5532 pr " void guestfs_free_%s_list (struct guestfs_free_%s_list *);\n"
5537 and generate_availability_pod () =
5538 (* Availability documentation. *)
5542 fun (group, functions) ->
5543 pr "=item B<%s>\n" group;
5545 pr "The following functions:\n";
5546 List.iter (pr "L</guestfs_%s>\n") functions;
5552 (* Generate the protocol (XDR) file, 'guestfs_protocol.x' and
5553 * indirectly 'guestfs_protocol.h' and 'guestfs_protocol.c'.
5555 * We have to use an underscore instead of a dash because otherwise
5556 * rpcgen generates incorrect code.
5558 * This header is NOT exported to clients, but see also generate_structs_h.
5560 and generate_xdr () =
5561 generate_header CStyle LGPLv2plus;
5563 (* This has to be defined to get around a limitation in Sun's rpcgen. *)
5564 pr "typedef string str<>;\n";
5567 (* Internal structures. *)
5571 pr "struct guestfs_int_%s {\n" typ;
5573 | name, FChar -> pr " char %s;\n" name
5574 | name, FString -> pr " string %s<>;\n" name
5575 | name, FBuffer -> pr " opaque %s<>;\n" name
5576 | name, FUUID -> pr " opaque %s[32];\n" name
5577 | name, (FInt32|FUInt32) -> pr " int %s;\n" name
5578 | name, (FInt64|FUInt64|FBytes) -> pr " hyper %s;\n" name
5579 | name, FOptPercent -> pr " float %s;\n" name
5583 pr "typedef struct guestfs_int_%s guestfs_int_%s_list<>;\n" typ typ;
5588 fun (shortname, style, _, _, _, _, _) ->
5589 let name = "guestfs_" ^ shortname in
5591 (match snd style with
5594 pr "struct %s_args {\n" name;
5597 | Pathname n | Device n | Dev_or_Path n | String n ->
5598 pr " string %s<>;\n" n
5599 | OptString n -> pr " str *%s;\n" n
5600 | StringList n | DeviceList n -> pr " str %s<>;\n" n
5601 | Bool n -> pr " bool %s;\n" n
5602 | Int n -> pr " int %s;\n" n
5603 | Int64 n -> pr " hyper %s;\n" n
5605 pr " opaque %s<>;\n" n
5606 | FileIn _ | FileOut _ -> ()
5610 (match fst style with
5613 pr "struct %s_ret {\n" name;
5617 pr "struct %s_ret {\n" name;
5618 pr " hyper %s;\n" n;
5621 pr "struct %s_ret {\n" name;
5624 | RConstString _ | RConstOptString _ ->
5625 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5627 pr "struct %s_ret {\n" name;
5628 pr " string %s<>;\n" n;
5631 pr "struct %s_ret {\n" name;
5632 pr " str %s<>;\n" n;
5634 | RStruct (n, typ) ->
5635 pr "struct %s_ret {\n" name;
5636 pr " guestfs_int_%s %s;\n" typ n;
5638 | RStructList (n, typ) ->
5639 pr "struct %s_ret {\n" name;
5640 pr " guestfs_int_%s_list %s;\n" typ n;
5643 pr "struct %s_ret {\n" name;
5644 pr " str %s<>;\n" n;
5647 pr "struct %s_ret {\n" name;
5648 pr " opaque %s<>;\n" n;
5653 (* Table of procedure numbers. *)
5654 pr "enum guestfs_procedure {\n";
5656 fun (shortname, _, proc_nr, _, _, _, _) ->
5657 pr " GUESTFS_PROC_%s = %d,\n" (String.uppercase shortname) proc_nr
5659 pr " GUESTFS_PROC_NR_PROCS\n";
5663 (* Having to choose a maximum message size is annoying for several
5664 * reasons (it limits what we can do in the API), but it (a) makes
5665 * the protocol a lot simpler, and (b) provides a bound on the size
5666 * of the daemon which operates in limited memory space.
5668 pr "const GUESTFS_MESSAGE_MAX = %d;\n" (4 * 1024 * 1024);
5671 (* Message header, etc. *)
5673 /* The communication protocol is now documented in the guestfs(3)
5677 const GUESTFS_PROGRAM = 0x2000F5F5;
5678 const GUESTFS_PROTOCOL_VERSION = 1;
5680 /* These constants must be larger than any possible message length. */
5681 const GUESTFS_LAUNCH_FLAG = 0xf5f55ff5;
5682 const GUESTFS_CANCEL_FLAG = 0xffffeeee;
5684 enum guestfs_message_direction {
5685 GUESTFS_DIRECTION_CALL = 0, /* client -> daemon */
5686 GUESTFS_DIRECTION_REPLY = 1 /* daemon -> client */
5689 enum guestfs_message_status {
5690 GUESTFS_STATUS_OK = 0,
5691 GUESTFS_STATUS_ERROR = 1
5694 const GUESTFS_ERROR_LEN = 256;
5696 struct guestfs_message_error {
5697 string error_message<GUESTFS_ERROR_LEN>;
5700 struct guestfs_message_header {
5701 unsigned prog; /* GUESTFS_PROGRAM */
5702 unsigned vers; /* GUESTFS_PROTOCOL_VERSION */
5703 guestfs_procedure proc; /* GUESTFS_PROC_x */
5704 guestfs_message_direction direction;
5705 unsigned serial; /* message serial number */
5706 guestfs_message_status status;
5709 const GUESTFS_MAX_CHUNK_SIZE = 8192;
5711 struct guestfs_chunk {
5712 int cancel; /* if non-zero, transfer is cancelled */
5713 /* data size is 0 bytes if the transfer has finished successfully */
5714 opaque data<GUESTFS_MAX_CHUNK_SIZE>;
5718 (* Generate the guestfs-structs.h file. *)
5719 and generate_structs_h () =
5720 generate_header CStyle LGPLv2plus;
5722 (* This is a public exported header file containing various
5723 * structures. The structures are carefully written to have
5724 * exactly the same in-memory format as the XDR structures that
5725 * we use on the wire to the daemon. The reason for creating
5726 * copies of these structures here is just so we don't have to
5727 * export the whole of guestfs_protocol.h (which includes much
5728 * unrelated and XDR-dependent stuff that we don't want to be
5729 * public, or required by clients).
5731 * To reiterate, we will pass these structures to and from the
5732 * client with a simple assignment or memcpy, so the format
5733 * must be identical to what rpcgen / the RFC defines.
5736 (* Public structures. *)
5739 pr "struct guestfs_%s {\n" typ;
5742 | name, FChar -> pr " char %s;\n" name
5743 | name, FString -> pr " char *%s;\n" name
5745 pr " uint32_t %s_len;\n" name;
5746 pr " char *%s;\n" name
5747 | name, FUUID -> pr " char %s[32]; /* this is NOT nul-terminated, be careful when printing */\n" name
5748 | name, FUInt32 -> pr " uint32_t %s;\n" name
5749 | name, FInt32 -> pr " int32_t %s;\n" name
5750 | name, (FUInt64|FBytes) -> pr " uint64_t %s;\n" name
5751 | name, FInt64 -> pr " int64_t %s;\n" name
5752 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
5756 pr "struct guestfs_%s_list {\n" typ;
5757 pr " uint32_t len;\n";
5758 pr " struct guestfs_%s *val;\n" typ;
5761 pr "extern void guestfs_free_%s (struct guestfs_%s *);\n" typ typ;
5762 pr "extern void guestfs_free_%s_list (struct guestfs_%s_list *);\n" typ typ;
5766 (* Generate the guestfs-actions.h file. *)
5767 and generate_actions_h () =
5768 generate_header CStyle LGPLv2plus;
5770 fun (shortname, style, _, _, _, _, _) ->
5771 let name = "guestfs_" ^ shortname in
5772 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5776 (* Generate the guestfs-internal-actions.h file. *)
5777 and generate_internal_actions_h () =
5778 generate_header CStyle LGPLv2plus;
5780 fun (shortname, style, _, _, _, _, _) ->
5781 let name = "guestfs__" ^ shortname in
5782 generate_prototype ~single_line:true ~newline:true ~handle:"g"
5784 ) non_daemon_functions
5786 (* Generate the client-side dispatch stubs. *)
5787 and generate_client_actions () =
5788 generate_header CStyle LGPLv2plus;
5795 #include <inttypes.h>
5797 #include \"guestfs.h\"
5798 #include \"guestfs-internal.h\"
5799 #include \"guestfs-internal-actions.h\"
5800 #include \"guestfs_protocol.h\"
5802 #define error guestfs_error
5803 //#define perrorf guestfs_perrorf
5804 #define safe_malloc guestfs_safe_malloc
5805 #define safe_realloc guestfs_safe_realloc
5806 //#define safe_strdup guestfs_safe_strdup
5807 #define safe_memdup guestfs_safe_memdup
5809 /* Check the return message from a call for validity. */
5811 check_reply_header (guestfs_h *g,
5812 const struct guestfs_message_header *hdr,
5813 unsigned int proc_nr, unsigned int serial)
5815 if (hdr->prog != GUESTFS_PROGRAM) {
5816 error (g, \"wrong program (%%d/%%d)\", hdr->prog, GUESTFS_PROGRAM);
5819 if (hdr->vers != GUESTFS_PROTOCOL_VERSION) {
5820 error (g, \"wrong protocol version (%%d/%%d)\",
5821 hdr->vers, GUESTFS_PROTOCOL_VERSION);
5824 if (hdr->direction != GUESTFS_DIRECTION_REPLY) {
5825 error (g, \"unexpected message direction (%%d/%%d)\",
5826 hdr->direction, GUESTFS_DIRECTION_REPLY);
5829 if (hdr->proc != proc_nr) {
5830 error (g, \"unexpected procedure number (%%d/%%d)\", hdr->proc, proc_nr);
5833 if (hdr->serial != serial) {
5834 error (g, \"unexpected serial (%%d/%%d)\", hdr->serial, serial);
5841 /* Check we are in the right state to run a high-level action. */
5843 check_state (guestfs_h *g, const char *caller)
5845 if (!guestfs__is_ready (g)) {
5846 if (guestfs__is_config (g) || guestfs__is_launching (g))
5847 error (g, \"%%s: call launch before using this function\\n(in guestfish, don't forget to use the 'run' command)\",
5850 error (g, \"%%s called from the wrong state, %%d != READY\",
5851 caller, guestfs__get_state (g));
5859 let error_code_of = function
5860 | RErr | RInt _ | RInt64 _ | RBool _ -> "-1"
5861 | RConstString _ | RConstOptString _
5862 | RString _ | RStringList _
5863 | RStruct _ | RStructList _
5864 | RHashtable _ | RBufferOut _ -> "NULL"
5867 (* Generate code to check String-like parameters are not passed in
5868 * as NULL (returning an error if they are).
5870 let check_null_strings shortname style =
5871 let pr_newline = ref false in
5874 (* parameters which should not be NULL *)
5884 pr " if (%s == NULL) {\n" n;
5885 pr " error (g, \"%%s: %%s: parameter cannot be NULL\",\n";
5886 pr " \"%s\", \"%s\");\n" shortname n;
5887 pr " return %s;\n" (error_code_of (fst style));
5894 (* not applicable *)
5900 if !pr_newline then pr "\n";
5903 (* Generate code to generate guestfish call traces. *)
5904 let trace_call shortname style =
5905 pr " if (guestfs__get_trace (g)) {\n";
5908 List.exists (function
5909 | StringList _ | DeviceList _ -> true
5910 | _ -> false) (snd style) in
5916 pr " printf (\"%s\");\n" shortname;
5919 | String n (* strings *)
5926 (* guestfish doesn't support string escaping, so neither do we *)
5927 pr " printf (\" \\\"%%s\\\"\", %s);\n" n
5928 | OptString n -> (* string option *)
5929 pr " if (%s) printf (\" \\\"%%s\\\"\", %s);\n" n n;
5930 pr " else printf (\" null\");\n"
5932 | DeviceList n -> (* string list *)
5933 pr " putchar (' ');\n";
5934 pr " putchar ('\"');\n";
5935 pr " for (i = 0; %s[i]; ++i) {\n" n;
5936 pr " if (i > 0) putchar (' ');\n";
5937 pr " fputs (%s[i], stdout);\n" n;
5939 pr " putchar ('\"');\n";
5940 | Bool n -> (* boolean *)
5941 pr " fputs (%s ? \" true\" : \" false\", stdout);\n" n
5942 | Int n -> (* int *)
5943 pr " printf (\" %%d\", %s);\n" n
5945 pr " printf (\" %%\" PRIi64, %s);\n" n
5947 pr " putchar ('\\n');\n";
5952 (* For non-daemon functions, generate a wrapper around each function. *)
5954 fun (shortname, style, _, _, _, _, _) ->
5955 let name = "guestfs_" ^ shortname in
5957 generate_prototype ~extern:false ~semicolon:false ~newline:true
5958 ~handle:"g" name style;
5960 check_null_strings shortname style;
5961 trace_call shortname style;
5962 pr " return guestfs__%s " shortname;
5963 generate_c_call_args ~handle:"g" style;
5967 ) non_daemon_functions;
5969 (* Client-side stubs for each function. *)
5971 fun (shortname, style, _, _, _, _, _) ->
5972 let name = "guestfs_" ^ shortname in
5973 let error_code = error_code_of (fst style) in
5975 (* Generate the action stub. *)
5976 generate_prototype ~extern:false ~semicolon:false ~newline:true
5977 ~handle:"g" name style;
5981 (match snd style with
5983 | _ -> pr " struct %s_args args;\n" name
5986 pr " guestfs_message_header hdr;\n";
5987 pr " guestfs_message_error err;\n";
5989 match fst style with
5991 | RConstString _ | RConstOptString _ ->
5992 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
5994 | RBool _ | RString _ | RStringList _
5995 | RStruct _ | RStructList _
5996 | RHashtable _ | RBufferOut _ ->
5997 pr " struct %s_ret ret;\n" name;
6000 pr " int serial;\n";
6003 check_null_strings shortname style;
6004 trace_call shortname style;
6005 pr " if (check_state (g, \"%s\") == -1) return %s;\n"
6006 shortname error_code;
6007 pr " guestfs___set_busy (g);\n";
6010 (* Send the main header and arguments. *)
6011 (match snd style with
6013 pr " serial = guestfs___send (g, GUESTFS_PROC_%s, NULL, NULL);\n"
6014 (String.uppercase shortname)
6018 | Pathname n | Device n | Dev_or_Path n | String n ->
6019 pr " args.%s = (char *) %s;\n" n n
6021 pr " args.%s = %s ? (char **) &%s : NULL;\n" n n n
6022 | StringList n | DeviceList n ->
6023 pr " args.%s.%s_val = (char **) %s;\n" n n n;
6024 pr " for (args.%s.%s_len = 0; %s[args.%s.%s_len]; args.%s.%s_len++) ;\n" n n n n n n n;
6026 pr " args.%s = %s;\n" n n
6028 pr " args.%s = %s;\n" n n
6030 pr " args.%s = %s;\n" n n
6031 | FileIn _ | FileOut _ -> ()
6033 pr " /* Just catch grossly large sizes. XDR encoding will make this precise. */\n";
6034 pr " if (%s_size >= GUESTFS_MESSAGE_MAX) {\n" n;
6035 pr " error (g, \"%%s: size of input buffer too large\", \"%s\");\n"
6037 pr " guestfs___end_busy (g);\n";
6038 pr " return %s;\n" error_code;
6040 pr " args.%s.%s_val = (char *) %s;\n" n n n;
6041 pr " args.%s.%s_len = %s_size;\n" n n n
6043 pr " serial = guestfs___send (g, GUESTFS_PROC_%s,\n"
6044 (String.uppercase shortname);
6045 pr " (xdrproc_t) xdr_%s_args, (char *) &args);\n"
6048 pr " if (serial == -1) {\n";
6049 pr " guestfs___end_busy (g);\n";
6050 pr " return %s;\n" error_code;
6054 (* Send any additional files (FileIn) requested. *)
6055 let need_read_reply_label = ref false in
6059 pr " r = guestfs___send_file (g, %s);\n" n;
6060 pr " if (r == -1) {\n";
6061 pr " guestfs___end_busy (g);\n";
6062 pr " return %s;\n" error_code;
6064 pr " if (r == -2) /* daemon cancelled */\n";
6065 pr " goto read_reply;\n";
6066 need_read_reply_label := true;
6071 (* Wait for the reply from the remote end. *)
6072 if !need_read_reply_label then pr " read_reply:\n";
6073 pr " memset (&hdr, 0, sizeof hdr);\n";
6074 pr " memset (&err, 0, sizeof err);\n";
6075 if has_ret then pr " memset (&ret, 0, sizeof ret);\n";
6077 pr " r = guestfs___recv (g, \"%s\", &hdr, &err,\n " shortname;
6081 pr "(xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret" shortname;
6084 pr " if (r == -1) {\n";
6085 pr " guestfs___end_busy (g);\n";
6086 pr " return %s;\n" error_code;
6090 pr " if (check_reply_header (g, &hdr, GUESTFS_PROC_%s, serial) == -1) {\n"
6091 (String.uppercase shortname);
6092 pr " guestfs___end_busy (g);\n";
6093 pr " return %s;\n" error_code;
6097 pr " if (hdr.status == GUESTFS_STATUS_ERROR) {\n";
6098 pr " error (g, \"%%s: %%s\", \"%s\", err.error_message);\n" shortname;
6099 pr " free (err.error_message);\n";
6100 pr " guestfs___end_busy (g);\n";
6101 pr " return %s;\n" error_code;
6105 (* Expecting to receive further files (FileOut)? *)
6109 pr " if (guestfs___recv_file (g, %s) == -1) {\n" n;
6110 pr " guestfs___end_busy (g);\n";
6111 pr " return %s;\n" error_code;
6117 pr " guestfs___end_busy (g);\n";
6119 (match fst style with
6120 | RErr -> pr " return 0;\n"
6121 | RInt n | RInt64 n | RBool n ->
6122 pr " return ret.%s;\n" n
6123 | RConstString _ | RConstOptString _ ->
6124 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6126 pr " return ret.%s; /* caller will free */\n" n
6127 | RStringList n | RHashtable n ->
6128 pr " /* caller will free this, but we need to add a NULL entry */\n";
6129 pr " ret.%s.%s_val =\n" n n;
6130 pr " safe_realloc (g, ret.%s.%s_val,\n" n n;
6131 pr " sizeof (char *) * (ret.%s.%s_len + 1));\n"
6133 pr " ret.%s.%s_val[ret.%s.%s_len] = NULL;\n" n n n n;
6134 pr " return ret.%s.%s_val;\n" n n
6136 pr " /* caller will free this */\n";
6137 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6138 | RStructList (n, _) ->
6139 pr " /* caller will free this */\n";
6140 pr " return safe_memdup (g, &ret.%s, sizeof (ret.%s));\n" n n
6142 pr " /* RBufferOut is tricky: If the buffer is zero-length, then\n";
6143 pr " * _val might be NULL here. To make the API saner for\n";
6144 pr " * callers, we turn this case into a unique pointer (using\n";
6145 pr " * malloc(1)).\n";
6147 pr " if (ret.%s.%s_len > 0) {\n" n n;
6148 pr " *size_r = ret.%s.%s_len;\n" n n;
6149 pr " return ret.%s.%s_val; /* caller will free */\n" n n;
6151 pr " free (ret.%s.%s_val);\n" n n;
6152 pr " char *p = safe_malloc (g, 1);\n";
6153 pr " *size_r = ret.%s.%s_len;\n" n n;
6161 (* Functions to free structures. *)
6162 pr "/* Structure-freeing functions. These rely on the fact that the\n";
6163 pr " * structure format is identical to the XDR format. See note in\n";
6164 pr " * generator.ml.\n";
6171 pr "guestfs_free_%s (struct guestfs_%s *x)\n" typ typ;
6173 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s, (char *) x);\n" typ;
6179 pr "guestfs_free_%s_list (struct guestfs_%s_list *x)\n" typ typ;
6181 pr " xdr_free ((xdrproc_t) xdr_guestfs_int_%s_list, (char *) x);\n" typ;
6188 (* Generate daemon/actions.h. *)
6189 and generate_daemon_actions_h () =
6190 generate_header CStyle GPLv2plus;
6192 pr "#include \"../src/guestfs_protocol.h\"\n";
6196 fun (name, style, _, _, _, _, _) ->
6198 ~single_line:true ~newline:true ~in_daemon:true ~prefix:"do_"
6202 (* Generate the linker script which controls the visibility of
6203 * symbols in the public ABI and ensures no other symbols get
6204 * exported accidentally.
6206 and generate_linker_script () =
6207 generate_header HashStyle GPLv2plus;
6212 "guestfs_get_error_handler";
6213 "guestfs_get_out_of_memory_handler";
6214 "guestfs_last_error";
6215 "guestfs_set_error_handler";
6216 "guestfs_set_launch_done_callback";
6217 "guestfs_set_log_message_callback";
6218 "guestfs_set_out_of_memory_handler";
6219 "guestfs_set_subprocess_quit_callback";
6221 (* Unofficial parts of the API: the bindings code use these
6222 * functions, so it is useful to export them.
6224 "guestfs_safe_calloc";
6225 "guestfs_safe_malloc";
6228 List.map (fun (name, _, _, _, _, _, _) -> "guestfs_" ^ name)
6232 List.map (fun (typ, _) ->
6233 ["guestfs_free_" ^ typ; "guestfs_free_" ^ typ ^ "_list"])
6236 let globals = List.sort compare (globals @ functions @ structs) in
6240 List.iter (pr " %s;\n") globals;
6247 (* Generate the server-side stubs. *)
6248 and generate_daemon_actions () =
6249 generate_header CStyle GPLv2plus;
6251 pr "#include <config.h>\n";
6253 pr "#include <stdio.h>\n";
6254 pr "#include <stdlib.h>\n";
6255 pr "#include <string.h>\n";
6256 pr "#include <inttypes.h>\n";
6257 pr "#include <rpc/types.h>\n";
6258 pr "#include <rpc/xdr.h>\n";
6260 pr "#include \"daemon.h\"\n";
6261 pr "#include \"c-ctype.h\"\n";
6262 pr "#include \"../src/guestfs_protocol.h\"\n";
6263 pr "#include \"actions.h\"\n";
6267 fun (name, style, _, _, _, _, _) ->
6268 (* Generate server-side stubs. *)
6269 pr "static void %s_stub (XDR *xdr_in)\n" name;
6272 match fst style with
6273 | RErr | RInt _ -> pr " int r;\n"; "-1"
6274 | RInt64 _ -> pr " int64_t r;\n"; "-1"
6275 | RBool _ -> pr " int r;\n"; "-1"
6276 | RConstString _ | RConstOptString _ ->
6277 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6278 | RString _ -> pr " char *r;\n"; "NULL"
6279 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
6280 | RStruct (_, typ) -> pr " guestfs_int_%s *r;\n" typ; "NULL"
6281 | RStructList (_, typ) -> pr " guestfs_int_%s_list *r;\n" typ; "NULL"
6283 pr " size_t size = 1;\n";
6287 (match snd style with
6290 pr " struct guestfs_%s_args args;\n" name;
6293 | Device n | Dev_or_Path n
6296 | OptString n -> pr " char *%s;\n" n
6297 | StringList n | DeviceList n -> pr " char **%s;\n" n
6298 | Bool n -> pr " int %s;\n" n
6299 | Int n -> pr " int %s;\n" n
6300 | Int64 n -> pr " int64_t %s;\n" n
6301 | FileIn _ | FileOut _ -> ()
6303 pr " const char *%s;\n" n;
6304 pr " size_t %s_size;\n" n
6310 List.exists (function FileIn _ -> true | _ -> false) (snd style) in
6312 (match snd style with
6315 pr " memset (&args, 0, sizeof args);\n";
6317 pr " if (!xdr_guestfs_%s_args (xdr_in, &args)) {\n" name;
6319 pr " if (cancel_receive () != -2)\n";
6320 pr " reply_with_error (\"daemon failed to decode procedure arguments\");\n";
6324 pr " char *%s = args.%s;\n" n n
6326 let pr_list_handling_code n =
6327 pr " %s = realloc (args.%s.%s_val,\n" n n n;
6328 pr " sizeof (char *) * (args.%s.%s_len+1));\n" n n;
6329 pr " if (%s == NULL) {\n" n;
6331 pr " if (cancel_receive () != -2)\n";
6332 pr " reply_with_perror (\"realloc\");\n";
6335 pr " %s[args.%s.%s_len] = NULL;\n" n n n;
6336 pr " args.%s.%s_val = %s;\n" n n n;
6342 pr " ABS_PATH (%s, %s, goto done);\n"
6343 n (if is_filein then "cancel_receive ()" else "0");
6346 pr " RESOLVE_DEVICE (%s, %s, goto done);\n"
6347 n (if is_filein then "cancel_receive ()" else "0");
6350 pr " REQUIRE_ROOT_OR_RESOLVE_DEVICE (%s, %s, goto done);\n"
6351 n (if is_filein then "cancel_receive ()" else "0");
6352 | String n -> pr_args n
6353 | OptString n -> pr " %s = args.%s ? *args.%s : NULL;\n" n n n
6355 pr_list_handling_code n;
6357 pr_list_handling_code n;
6358 pr " /* Ensure that each is a device,\n";
6359 pr " * and perform device name translation. */\n";
6360 pr " { int pvi; for (pvi = 0; physvols[pvi] != NULL; ++pvi)\n";
6361 pr " RESOLVE_DEVICE (physvols[pvi], %s, goto done);\n"
6362 (if is_filein then "cancel_receive ()" else "0");
6364 | Bool n -> pr " %s = args.%s;\n" n n
6365 | Int n -> pr " %s = args.%s;\n" n n
6366 | Int64 n -> pr " %s = args.%s;\n" n n
6367 | FileIn _ | FileOut _ -> ()
6369 pr " %s = args.%s.%s_val;\n" n n n;
6370 pr " %s_size = args.%s.%s_len;\n" n n n
6375 (* this is used at least for do_equal *)
6376 if List.exists (function Pathname _ -> true | _ -> false) (snd style) then (
6377 (* Emit NEED_ROOT just once, even when there are two or
6378 more Pathname args *)
6379 pr " NEED_ROOT (%s, goto done);\n"
6380 (if is_filein then "cancel_receive ()" else "0");
6383 (* Don't want to call the impl with any FileIn or FileOut
6384 * parameters, since these go "outside" the RPC protocol.
6387 List.filter (function FileIn _ | FileOut _ -> false | _ -> true)
6389 pr " r = do_%s " name;
6390 generate_c_call_args (fst style, args');
6393 (match fst style with
6394 | RErr | RInt _ | RInt64 _ | RBool _
6395 | RConstString _ | RConstOptString _
6396 | RString _ | RStringList _ | RHashtable _
6397 | RStruct (_, _) | RStructList (_, _) ->
6398 pr " if (r == %s)\n" error_code;
6399 pr " /* do_%s has already called reply_with_error */\n" name;
6403 pr " /* size == 0 && r == NULL could be a non-error case (just\n";
6404 pr " * an ordinary zero-length buffer), so be careful ...\n";
6406 pr " if (size == 1 && r == %s)\n" error_code;
6407 pr " /* do_%s has already called reply_with_error */\n" name;
6412 (* If there are any FileOut parameters, then the impl must
6413 * send its own reply.
6416 List.exists (function FileOut _ -> true | _ -> false) (snd style) in
6418 pr " /* do_%s has already sent a reply */\n" name
6420 match fst style with
6421 | RErr -> pr " reply (NULL, NULL);\n"
6422 | RInt n | RInt64 n | RBool n ->
6423 pr " struct guestfs_%s_ret ret;\n" name;
6424 pr " ret.%s = r;\n" n;
6425 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6427 | RConstString _ | RConstOptString _ ->
6428 failwithf "RConstString|RConstOptString cannot be used by daemon functions"
6430 pr " struct guestfs_%s_ret ret;\n" name;
6431 pr " ret.%s = r;\n" n;
6432 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6435 | RStringList n | RHashtable n ->
6436 pr " struct guestfs_%s_ret ret;\n" name;
6437 pr " ret.%s.%s_len = count_strings (r);\n" n n;
6438 pr " ret.%s.%s_val = r;\n" n n;
6439 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6441 pr " free_strings (r);\n"
6443 pr " struct guestfs_%s_ret ret;\n" name;
6444 pr " ret.%s = *r;\n" n;
6445 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6447 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6449 | RStructList (n, _) ->
6450 pr " struct guestfs_%s_ret ret;\n" name;
6451 pr " ret.%s = *r;\n" n;
6452 pr " reply ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6454 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_ret, (char *) &ret);\n"
6457 pr " struct guestfs_%s_ret ret;\n" name;
6458 pr " ret.%s.%s_val = r;\n" n n;
6459 pr " ret.%s.%s_len = size;\n" n n;
6460 pr " reply ((xdrproc_t) &xdr_guestfs_%s_ret, (char *) &ret);\n"
6465 (* Free the args. *)
6467 (match snd style with
6470 pr " xdr_free ((xdrproc_t) xdr_guestfs_%s_args, (char *) &args);\n"
6477 (* Dispatch function. *)
6478 pr "void dispatch_incoming_message (XDR *xdr_in)\n";
6480 pr " switch (proc_nr) {\n";
6483 fun (name, style, _, _, _, _, _) ->
6484 pr " case GUESTFS_PROC_%s:\n" (String.uppercase name);
6485 pr " %s_stub (xdr_in);\n" name;
6490 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";
6495 (* LVM columns and tokenization functions. *)
6496 (* XXX This generates crap code. We should rethink how we
6502 pr "static const char *lvm_%s_cols = \"%s\";\n"
6503 typ (String.concat "," (List.map fst cols));
6506 pr "static int lvm_tokenize_%s (char *str, guestfs_int_lvm_%s *r)\n" typ typ;
6508 pr " char *tok, *p, *next;\n";
6512 pr " fprintf (stderr, \"%%s: <<%%s>>\\n\", __func__, str);\n";
6515 pr " if (!str) {\n";
6516 pr " fprintf (stderr, \"%%s: failed: passed a NULL string\\n\", __func__);\n";
6519 pr " if (!*str || c_isspace (*str)) {\n";
6520 pr " fprintf (stderr, \"%%s: failed: passed a empty string or one beginning with whitespace\\n\", __func__);\n";
6525 fun (name, coltype) ->
6526 pr " if (!tok) {\n";
6527 pr " fprintf (stderr, \"%%s: failed: string finished early, around token %%s\\n\", __func__, \"%s\");\n" name;
6530 pr " p = strchrnul (tok, ',');\n";
6531 pr " if (*p) next = p+1; else next = NULL;\n";
6532 pr " *p = '\\0';\n";
6535 pr " r->%s = strdup (tok);\n" name;
6536 pr " if (r->%s == NULL) {\n" name;
6537 pr " perror (\"strdup\");\n";
6541 pr " for (i = j = 0; i < 32; ++j) {\n";
6542 pr " if (tok[j] == '\\0') {\n";
6543 pr " fprintf (stderr, \"%%s: failed to parse UUID from '%%s'\\n\", __func__, tok);\n";
6545 pr " } else if (tok[j] != '-')\n";
6546 pr " r->%s[i++] = tok[j];\n" name;
6549 pr " if (sscanf (tok, \"%%\"SCNu64, &r->%s) != 1) {\n" name;
6550 pr " fprintf (stderr, \"%%s: failed to parse size '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6554 pr " if (sscanf (tok, \"%%\"SCNi64, &r->%s) != 1) {\n" name;
6555 pr " fprintf (stderr, \"%%s: failed to parse int '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6559 pr " if (tok[0] == '\\0')\n";
6560 pr " r->%s = -1;\n" name;
6561 pr " else if (sscanf (tok, \"%%f\", &r->%s) != 1) {\n" name;
6562 pr " fprintf (stderr, \"%%s: failed to parse float '%%s' from token %%s\\n\", __func__, tok, \"%s\");\n" name;
6565 | FBuffer | FInt32 | FUInt32 | FUInt64 | FChar ->
6566 assert false (* can never be an LVM column *)
6568 pr " tok = next;\n";
6571 pr " if (tok != NULL) {\n";
6572 pr " fprintf (stderr, \"%%s: failed: extra tokens at end of string\\n\", __func__);\n";
6579 pr "guestfs_int_lvm_%s_list *\n" typ;
6580 pr "parse_command_line_%ss (void)\n" typ;
6582 pr " char *out, *err;\n";
6583 pr " char *p, *pend;\n";
6585 pr " guestfs_int_lvm_%s_list *ret;\n" typ;
6586 pr " void *newp;\n";
6588 pr " ret = malloc (sizeof *ret);\n";
6589 pr " if (!ret) {\n";
6590 pr " reply_with_perror (\"malloc\");\n";
6591 pr " return NULL;\n";
6594 pr " ret->guestfs_int_lvm_%s_list_len = 0;\n" typ;
6595 pr " ret->guestfs_int_lvm_%s_list_val = NULL;\n" typ;
6597 pr " r = command (&out, &err,\n";
6598 pr " \"lvm\", \"%ss\",\n" typ;
6599 pr " \"-o\", lvm_%s_cols, \"--unbuffered\", \"--noheadings\",\n" typ;
6600 pr " \"--nosuffix\", \"--separator\", \",\", \"--units\", \"b\", NULL);\n";
6601 pr " if (r == -1) {\n";
6602 pr " reply_with_error (\"%%s\", err);\n";
6603 pr " free (out);\n";
6604 pr " free (err);\n";
6605 pr " free (ret);\n";
6606 pr " return NULL;\n";
6609 pr " free (err);\n";
6611 pr " /* Tokenize each line of the output. */\n";
6614 pr " while (p) {\n";
6615 pr " pend = strchr (p, '\\n'); /* Get the next line of output. */\n";
6616 pr " if (pend) {\n";
6617 pr " *pend = '\\0';\n";
6621 pr " while (*p && c_isspace (*p)) /* Skip any leading whitespace. */\n";
6624 pr " if (!*p) { /* Empty line? Skip it. */\n";
6629 pr " /* Allocate some space to store this next entry. */\n";
6630 pr " newp = realloc (ret->guestfs_int_lvm_%s_list_val,\n" typ;
6631 pr " sizeof (guestfs_int_lvm_%s) * (i+1));\n" typ;
6632 pr " if (newp == NULL) {\n";
6633 pr " reply_with_perror (\"realloc\");\n";
6634 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6635 pr " free (ret);\n";
6636 pr " free (out);\n";
6637 pr " return NULL;\n";
6639 pr " ret->guestfs_int_lvm_%s_list_val = newp;\n" typ;
6641 pr " /* Tokenize the next entry. */\n";
6642 pr " r = lvm_tokenize_%s (p, &ret->guestfs_int_lvm_%s_list_val[i]);\n" typ typ;
6643 pr " if (r == -1) {\n";
6644 pr " reply_with_error (\"failed to parse output of '%ss' command\");\n" typ;
6645 pr " free (ret->guestfs_int_lvm_%s_list_val);\n" typ;
6646 pr " free (ret);\n";
6647 pr " free (out);\n";
6648 pr " return NULL;\n";
6655 pr " ret->guestfs_int_lvm_%s_list_len = i;\n" typ;
6657 pr " free (out);\n";
6658 pr " return ret;\n";
6661 ) ["pv", lvm_pv_cols; "vg", lvm_vg_cols; "lv", lvm_lv_cols]
6663 (* Generate a list of function names, for debugging in the daemon.. *)
6664 and generate_daemon_names () =
6665 generate_header CStyle GPLv2plus;
6667 pr "#include <config.h>\n";
6669 pr "#include \"daemon.h\"\n";
6672 pr "/* This array is indexed by proc_nr. See guestfs_protocol.x. */\n";
6673 pr "const char *function_names[] = {\n";
6675 fun (name, _, proc_nr, _, _, _, _) -> pr " [%d] = \"%s\",\n" proc_nr name
6679 (* Generate the optional groups for the daemon to implement
6680 * guestfs_available.
6682 and generate_daemon_optgroups_c () =
6683 generate_header CStyle GPLv2plus;
6685 pr "#include <config.h>\n";
6687 pr "#include \"daemon.h\"\n";
6688 pr "#include \"optgroups.h\"\n";
6691 pr "struct optgroup optgroups[] = {\n";
6694 pr " { \"%s\", optgroup_%s_available },\n" group group
6696 pr " { NULL, NULL }\n";
6699 and generate_daemon_optgroups_h () =
6700 generate_header CStyle GPLv2plus;
6704 pr "extern int optgroup_%s_available (void);\n" group
6707 (* Generate the tests. *)
6708 and generate_tests () =
6709 generate_header CStyle GPLv2plus;
6716 #include <sys/types.h>
6719 #include \"guestfs.h\"
6720 #include \"guestfs-internal.h\"
6722 static guestfs_h *g;
6723 static int suppress_error = 0;
6725 static void print_error (guestfs_h *g, void *data, const char *msg)
6727 if (!suppress_error)
6728 fprintf (stderr, \"%%s\\n\", msg);
6731 /* FIXME: nearly identical code appears in fish.c */
6732 static void print_strings (char *const *argv)
6736 for (argc = 0; argv[argc] != NULL; ++argc)
6737 printf (\"\\t%%s\\n\", argv[argc]);
6741 static void print_table (char const *const *argv)
6745 for (i = 0; argv[i] != NULL; i += 2)
6746 printf (\"%%s: %%s\\n\", argv[i], argv[i+1]);
6752 (* Generate a list of commands which are not tested anywhere. *)
6753 pr "static void no_test_warnings (void)\n";
6756 let hash : (string, bool) Hashtbl.t = Hashtbl.create 13 in
6758 fun (_, _, _, _, tests, _, _) ->
6759 let tests = filter_map (
6761 | (_, (Always|If _|Unless _), test) -> Some test
6762 | (_, Disabled, _) -> None
6764 let seq = List.concat (List.map seq_of_test tests) in
6765 let cmds_tested = List.map List.hd seq in
6766 List.iter (fun cmd -> Hashtbl.replace hash cmd true) cmds_tested
6770 fun (name, _, _, _, _, _, _) ->
6771 if not (Hashtbl.mem hash name) then
6772 pr " fprintf (stderr, \"warning: \\\"guestfs_%s\\\" has no tests\\n\");\n" name
6778 (* Generate the actual tests. Note that we generate the tests
6779 * in reverse order, deliberately, so that (in general) the
6780 * newest tests run first. This makes it quicker and easier to
6785 fun (name, _, _, flags, tests, _, _) ->
6786 mapi (generate_one_test name flags) tests
6787 ) (List.rev all_functions) in
6788 let test_names = List.concat test_names in
6789 let nr_tests = List.length test_names in
6792 int main (int argc, char *argv[])
6795 unsigned long int n_failed = 0;
6796 const char *filename;
6798 int nr_tests, test_num = 0;
6800 setbuf (stdout, NULL);
6802 no_test_warnings ();
6804 g = guestfs_create ();
6806 printf (\"guestfs_create FAILED\\n\");
6807 exit (EXIT_FAILURE);
6810 guestfs_set_error_handler (g, print_error, NULL);
6812 guestfs_set_path (g, \"../appliance\");
6814 filename = \"test1.img\";
6815 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6818 exit (EXIT_FAILURE);
6820 if (lseek (fd, %d, SEEK_SET) == -1) {
6824 exit (EXIT_FAILURE);
6826 if (write (fd, &c, 1) == -1) {
6830 exit (EXIT_FAILURE);
6832 if (close (fd) == -1) {
6835 exit (EXIT_FAILURE);
6837 if (guestfs_add_drive (g, filename) == -1) {
6838 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6839 exit (EXIT_FAILURE);
6842 filename = \"test2.img\";
6843 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6846 exit (EXIT_FAILURE);
6848 if (lseek (fd, %d, SEEK_SET) == -1) {
6852 exit (EXIT_FAILURE);
6854 if (write (fd, &c, 1) == -1) {
6858 exit (EXIT_FAILURE);
6860 if (close (fd) == -1) {
6863 exit (EXIT_FAILURE);
6865 if (guestfs_add_drive (g, filename) == -1) {
6866 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6867 exit (EXIT_FAILURE);
6870 filename = \"test3.img\";
6871 fd = open (filename, O_WRONLY|O_CREAT|O_NOCTTY|O_NONBLOCK|O_TRUNC, 0666);
6874 exit (EXIT_FAILURE);
6876 if (lseek (fd, %d, SEEK_SET) == -1) {
6880 exit (EXIT_FAILURE);
6882 if (write (fd, &c, 1) == -1) {
6886 exit (EXIT_FAILURE);
6888 if (close (fd) == -1) {
6891 exit (EXIT_FAILURE);
6893 if (guestfs_add_drive (g, filename) == -1) {
6894 printf (\"guestfs_add_drive %%s FAILED\\n\", filename);
6895 exit (EXIT_FAILURE);
6898 if (guestfs_add_drive_ro (g, \"../images/test.iso\") == -1) {
6899 printf (\"guestfs_add_drive_ro ../images/test.iso FAILED\\n\");
6900 exit (EXIT_FAILURE);
6903 /* Set a timeout in case qemu hangs during launch (RHBZ#505329). */
6906 if (guestfs_launch (g) == -1) {
6907 printf (\"guestfs_launch FAILED\\n\");
6908 exit (EXIT_FAILURE);
6911 /* Cancel previous alarm. */
6916 " (500 * 1024 * 1024) (50 * 1024 * 1024) (10 * 1024 * 1024) nr_tests;
6920 pr " test_num++;\n";
6921 pr " if (guestfs_get_verbose (g))\n";
6922 pr " printf (\"-------------------------------------------------------------------------------\\n\");\n";
6923 pr " printf (\"%%3d/%%3d %s\\n\", test_num, nr_tests);\n" test_name;
6924 pr " if (%s () == -1) {\n" test_name;
6925 pr " printf (\"%s FAILED\\n\");\n" test_name;
6926 pr " n_failed++;\n";
6931 pr " guestfs_close (g);\n";
6932 pr " unlink (\"test1.img\");\n";
6933 pr " unlink (\"test2.img\");\n";
6934 pr " unlink (\"test3.img\");\n";
6937 pr " if (n_failed > 0) {\n";
6938 pr " printf (\"***** %%lu / %%d tests FAILED *****\\n\", n_failed, nr_tests);\n";
6939 pr " exit (EXIT_FAILURE);\n";
6943 pr " exit (EXIT_SUCCESS);\n";
6946 and generate_one_test name flags i (init, prereq, test) =
6947 let test_name = sprintf "test_%s_%d" name i in
6950 static int %s_skip (void)
6954 str = getenv (\"TEST_ONLY\");
6956 return strstr (str, \"%s\") == NULL;
6957 str = getenv (\"SKIP_%s\");
6958 if (str && STREQ (str, \"1\")) return 1;
6959 str = getenv (\"SKIP_TEST_%s\");
6960 if (str && STREQ (str, \"1\")) return 1;
6964 " test_name name (String.uppercase test_name) (String.uppercase name);
6967 | Disabled | Always -> ()
6968 | If code | Unless code ->
6969 pr "static int %s_prereq (void)\n" test_name;
6977 static int %s (void)
6980 printf (\" %%s skipped (reason: environment variable set)\\n\", \"%s\");
6984 " test_name test_name test_name;
6986 (* Optional functions should only be tested if the relevant
6987 * support is available in the daemon.
6993 pr " const char *groups[] = { \"%s\", NULL };\n" group;
6995 pr " suppress_error = 1;\n";
6996 pr " r = guestfs_available (g, (char **) groups);\n";
6997 pr " suppress_error = 0;\n";
6998 pr " if (r == -1) {\n";
6999 pr " printf (\" %%s skipped (reason: group %%s not available in daemon)\\n\", \"%s\", groups[0]);\n" test_name;
7008 pr " printf (\" %%s skipped (reason: test disabled in generator)\\n\", \"%s\");\n" test_name
7010 pr " if (! %s_prereq ()) {\n" test_name;
7011 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7015 generate_one_test_body name i test_name init test;
7017 pr " if (%s_prereq ()) {\n" test_name;
7018 pr " printf (\" %%s skipped (reason: test prerequisite)\\n\", \"%s\");\n" test_name;
7022 generate_one_test_body name i test_name init test;
7024 generate_one_test_body name i test_name init test
7032 and generate_one_test_body name i test_name init test =
7034 | InitNone (* XXX at some point, InitNone and InitEmpty became
7035 * folded together as the same thing. Really we should
7036 * make InitNone do nothing at all, but the tests may
7037 * need to be checked to make sure this is OK.
7040 pr " /* InitNone|InitEmpty for %s */\n" test_name;
7041 List.iter (generate_test_command_call test_name)
7042 [["blockdev_setrw"; "/dev/sda"];
7046 pr " /* InitPartition for %s: create /dev/sda1 */\n" test_name;
7047 List.iter (generate_test_command_call test_name)
7048 [["blockdev_setrw"; "/dev/sda"];
7051 ["part_disk"; "/dev/sda"; "mbr"]]
7053 pr " /* InitBasicFS for %s: create ext2 on /dev/sda1 */\n" test_name;
7054 List.iter (generate_test_command_call test_name)
7055 [["blockdev_setrw"; "/dev/sda"];
7058 ["part_disk"; "/dev/sda"; "mbr"];
7059 ["mkfs"; "ext2"; "/dev/sda1"];
7060 ["mount_options"; ""; "/dev/sda1"; "/"]]
7061 | InitBasicFSonLVM ->
7062 pr " /* InitBasicFSonLVM for %s: create ext2 on /dev/VG/LV */\n"
7064 List.iter (generate_test_command_call test_name)
7065 [["blockdev_setrw"; "/dev/sda"];
7068 ["part_disk"; "/dev/sda"; "mbr"];
7069 ["pvcreate"; "/dev/sda1"];
7070 ["vgcreate"; "VG"; "/dev/sda1"];
7071 ["lvcreate"; "LV"; "VG"; "8"];
7072 ["mkfs"; "ext2"; "/dev/VG/LV"];
7073 ["mount_options"; ""; "/dev/VG/LV"; "/"]]
7075 pr " /* InitISOFS for %s */\n" test_name;
7076 List.iter (generate_test_command_call test_name)
7077 [["blockdev_setrw"; "/dev/sda"];
7080 ["mount_ro"; "/dev/sdd"; "/"]]
7083 let get_seq_last = function
7085 failwithf "%s: you cannot use [] (empty list) when expecting a command"
7088 let seq = List.rev seq in
7089 List.rev (List.tl seq), List.hd seq
7094 pr " /* TestRun for %s (%d) */\n" name i;
7095 List.iter (generate_test_command_call test_name) seq
7096 | TestOutput (seq, expected) ->
7097 pr " /* TestOutput for %s (%d) */\n" name i;
7098 pr " const char *expected = \"%s\";\n" (c_quote expected);
7099 let seq, last = get_seq_last seq in
7101 pr " if (STRNEQ (r, expected)) {\n";
7102 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7106 List.iter (generate_test_command_call test_name) seq;
7107 generate_test_command_call ~test test_name last
7108 | TestOutputList (seq, expected) ->
7109 pr " /* TestOutputList for %s (%d) */\n" name i;
7110 let seq, last = get_seq_last seq in
7114 pr " if (!r[%d]) {\n" i;
7115 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7116 pr " print_strings (r);\n";
7120 pr " const char *expected = \"%s\";\n" (c_quote str);
7121 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7122 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7127 pr " if (r[%d] != NULL) {\n" (List.length expected);
7128 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7130 pr " print_strings (r);\n";
7134 List.iter (generate_test_command_call test_name) seq;
7135 generate_test_command_call ~test test_name last
7136 | TestOutputListOfDevices (seq, expected) ->
7137 pr " /* TestOutputListOfDevices for %s (%d) */\n" name i;
7138 let seq, last = get_seq_last seq in
7142 pr " if (!r[%d]) {\n" i;
7143 pr " fprintf (stderr, \"%s: short list returned from command\\n\");\n" test_name;
7144 pr " print_strings (r);\n";
7148 pr " const char *expected = \"%s\";\n" (c_quote str);
7149 pr " r[%d][5] = 's';\n" i;
7150 pr " if (STRNEQ (r[%d], expected)) {\n" i;
7151 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r[%d]);\n" test_name i;
7156 pr " if (r[%d] != NULL) {\n" (List.length expected);
7157 pr " fprintf (stderr, \"%s: extra elements returned from command\\n\");\n"
7159 pr " print_strings (r);\n";
7163 List.iter (generate_test_command_call test_name) seq;
7164 generate_test_command_call ~test test_name last
7165 | TestOutputInt (seq, expected) ->
7166 pr " /* TestOutputInt for %s (%d) */\n" name i;
7167 let seq, last = get_seq_last seq in
7169 pr " if (r != %d) {\n" expected;
7170 pr " fprintf (stderr, \"%s: expected %d but got %%d\\n\","
7176 List.iter (generate_test_command_call test_name) seq;
7177 generate_test_command_call ~test test_name last
7178 | TestOutputIntOp (seq, op, expected) ->
7179 pr " /* TestOutputIntOp for %s (%d) */\n" name i;
7180 let seq, last = get_seq_last seq in
7182 pr " if (! (r %s %d)) {\n" op expected;
7183 pr " fprintf (stderr, \"%s: expected %s %d but got %%d\\n\","
7184 test_name op expected;
7189 List.iter (generate_test_command_call test_name) seq;
7190 generate_test_command_call ~test test_name last
7191 | TestOutputTrue seq ->
7192 pr " /* TestOutputTrue for %s (%d) */\n" name i;
7193 let seq, last = get_seq_last seq in
7196 pr " fprintf (stderr, \"%s: expected true, got false\\n\");\n"
7201 List.iter (generate_test_command_call test_name) seq;
7202 generate_test_command_call ~test test_name last
7203 | TestOutputFalse seq ->
7204 pr " /* TestOutputFalse for %s (%d) */\n" name i;
7205 let seq, last = get_seq_last seq in
7208 pr " fprintf (stderr, \"%s: expected false, got true\\n\");\n"
7213 List.iter (generate_test_command_call test_name) seq;
7214 generate_test_command_call ~test test_name last
7215 | TestOutputLength (seq, expected) ->
7216 pr " /* TestOutputLength for %s (%d) */\n" name i;
7217 let seq, last = get_seq_last seq in
7220 pr " for (j = 0; j < %d; ++j)\n" expected;
7221 pr " if (r[j] == NULL) {\n";
7222 pr " fprintf (stderr, \"%s: short list returned\\n\");\n"
7224 pr " print_strings (r);\n";
7227 pr " if (r[j] != NULL) {\n";
7228 pr " fprintf (stderr, \"%s: long list returned\\n\");\n"
7230 pr " print_strings (r);\n";
7234 List.iter (generate_test_command_call test_name) seq;
7235 generate_test_command_call ~test test_name last
7236 | TestOutputBuffer (seq, expected) ->
7237 pr " /* TestOutputBuffer for %s (%d) */\n" name i;
7238 pr " const char *expected = \"%s\";\n" (c_quote expected);
7239 let seq, last = get_seq_last seq in
7240 let len = String.length expected in
7242 pr " if (size != %d) {\n" len;
7243 pr " fprintf (stderr, \"%s: returned size of buffer wrong, expected %d but got %%zu\\n\", size);\n" test_name len;
7246 pr " if (STRNEQLEN (r, expected, size)) {\n";
7247 pr " fprintf (stderr, \"%s: expected \\\"%%s\\\" but got \\\"%%s\\\"\\n\", expected, r);\n" test_name;
7251 List.iter (generate_test_command_call test_name) seq;
7252 generate_test_command_call ~test test_name last
7253 | TestOutputStruct (seq, checks) ->
7254 pr " /* TestOutputStruct for %s (%d) */\n" name i;
7255 let seq, last = get_seq_last seq in
7259 | CompareWithInt (field, expected) ->
7260 pr " if (r->%s != %d) {\n" field expected;
7261 pr " fprintf (stderr, \"%s: %s was %%d, expected %d\\n\",\n"
7262 test_name field expected;
7263 pr " (int) r->%s);\n" field;
7266 | CompareWithIntOp (field, op, expected) ->
7267 pr " if (!(r->%s %s %d)) {\n" field op expected;
7268 pr " fprintf (stderr, \"%s: %s was %%d, expected %s %d\\n\",\n"
7269 test_name field op expected;
7270 pr " (int) r->%s);\n" field;
7273 | CompareWithString (field, expected) ->
7274 pr " if (STRNEQ (r->%s, \"%s\")) {\n" field expected;
7275 pr " fprintf (stderr, \"%s: %s was \"%%s\", expected \"%s\"\\n\",\n"
7276 test_name field expected;
7277 pr " r->%s);\n" field;
7280 | CompareFieldsIntEq (field1, field2) ->
7281 pr " if (r->%s != r->%s) {\n" field1 field2;
7282 pr " fprintf (stderr, \"%s: %s (%%d) <> %s (%%d)\\n\",\n"
7283 test_name field1 field2;
7284 pr " (int) r->%s, (int) r->%s);\n" field1 field2;
7287 | CompareFieldsStrEq (field1, field2) ->
7288 pr " if (STRNEQ (r->%s, r->%s)) {\n" field1 field2;
7289 pr " fprintf (stderr, \"%s: %s (\"%%s\") <> %s (\"%%s\")\\n\",\n"
7290 test_name field1 field2;
7291 pr " r->%s, r->%s);\n" field1 field2;
7296 List.iter (generate_test_command_call test_name) seq;
7297 generate_test_command_call ~test test_name last
7298 | TestLastFail seq ->
7299 pr " /* TestLastFail for %s (%d) */\n" name i;
7300 let seq, last = get_seq_last seq in
7301 List.iter (generate_test_command_call test_name) seq;
7302 generate_test_command_call test_name ~expect_error:true last
7304 (* Generate the code to run a command, leaving the result in 'r'.
7305 * If you expect to get an error then you should set expect_error:true.
7307 and generate_test_command_call ?(expect_error = false) ?test test_name cmd =
7309 | [] -> assert false
7311 (* Look up the command to find out what args/ret it has. *)
7314 let _, style, _, _, _, _, _ =
7315 List.find (fun (n, _, _, _, _, _, _) -> n = name) all_functions in
7318 failwithf "%s: in test, command %s was not found" test_name name in
7320 if List.length (snd style) <> List.length args then
7321 failwithf "%s: in test, wrong number of args given to %s"
7328 | OptString n, "NULL" -> ()
7331 | Dev_or_Path n, arg
7333 | OptString n, arg ->
7334 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7335 | BufferIn n, arg ->
7336 pr " const char *%s = \"%s\";\n" n (c_quote arg);
7337 pr " size_t %s_size = %d;\n" n (String.length arg)
7341 | FileIn _, _ | FileOut _, _ -> ()
7342 | StringList n, "" | DeviceList n, "" ->
7343 pr " const char *const %s[1] = { NULL };\n" n
7344 | StringList n, arg | DeviceList n, arg ->
7345 let strs = string_split " " arg in
7348 pr " const char *%s_%d = \"%s\";\n" n i (c_quote str);
7350 pr " const char *const %s[] = {\n" n;
7352 fun i _ -> pr " %s_%d,\n" n i
7356 ) (List.combine (snd style) args);
7359 match fst style with
7360 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
7361 | RInt64 _ -> pr " int64_t r;\n"; "-1"
7362 | RConstString _ | RConstOptString _ ->
7363 pr " const char *r;\n"; "NULL"
7364 | RString _ -> pr " char *r;\n"; "NULL"
7365 | RStringList _ | RHashtable _ ->
7369 | RStruct (_, typ) ->
7370 pr " struct guestfs_%s *r;\n" typ; "NULL"
7371 | RStructList (_, typ) ->
7372 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
7375 pr " size_t size;\n";
7378 pr " suppress_error = %d;\n" (if expect_error then 1 else 0);
7379 pr " r = guestfs_%s (g" name;
7381 (* Generate the parameters. *)
7384 | OptString _, "NULL" -> pr ", NULL"
7386 | Device n, _ | Dev_or_Path n, _
7391 pr ", %s, %s_size" n n
7392 | FileIn _, arg | FileOut _, arg ->
7393 pr ", \"%s\"" (c_quote arg)
7394 | StringList n, _ | DeviceList n, _ ->
7395 pr ", (char **) %s" n
7398 try int_of_string arg
7399 with Failure "int_of_string" ->
7400 failwithf "%s: expecting an int, but got '%s'" test_name arg in
7404 try Int64.of_string arg
7405 with Failure "int_of_string" ->
7406 failwithf "%s: expecting an int64, but got '%s'" test_name arg in
7409 let b = bool_of_string arg in pr ", %d" (if b then 1 else 0)
7410 ) (List.combine (snd style) args);
7412 (match fst style with
7413 | RBufferOut _ -> pr ", &size"
7419 if not expect_error then
7420 pr " if (r == %s)\n" error_code
7422 pr " if (r != %s)\n" error_code;
7425 (* Insert the test code. *)
7431 (match fst style with
7432 | RErr | RInt _ | RInt64 _ | RBool _
7433 | RConstString _ | RConstOptString _ -> ()
7434 | RString _ | RBufferOut _ -> pr " free (r);\n"
7435 | RStringList _ | RHashtable _ ->
7436 pr " for (i = 0; r[i] != NULL; ++i)\n";
7437 pr " free (r[i]);\n";
7439 | RStruct (_, typ) ->
7440 pr " guestfs_free_%s (r);\n" typ
7441 | RStructList (_, typ) ->
7442 pr " guestfs_free_%s_list (r);\n" typ
7448 let str = replace_str str "\r" "\\r" in
7449 let str = replace_str str "\n" "\\n" in
7450 let str = replace_str str "\t" "\\t" in
7451 let str = replace_str str "\000" "\\0" in
7454 (* Generate a lot of different functions for guestfish. *)
7455 and generate_fish_cmds () =
7456 generate_header CStyle GPLv2plus;
7460 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7462 let all_functions_sorted =
7464 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7465 ) all_functions_sorted in
7467 pr "#include <config.h>\n";
7469 pr "#include <stdio.h>\n";
7470 pr "#include <stdlib.h>\n";
7471 pr "#include <string.h>\n";
7472 pr "#include <inttypes.h>\n";
7474 pr "#include <guestfs.h>\n";
7475 pr "#include \"c-ctype.h\"\n";
7476 pr "#include \"full-write.h\"\n";
7477 pr "#include \"xstrtol.h\"\n";
7478 pr "#include \"fish.h\"\n";
7480 pr "/* Valid suffixes allowed for numbers. See Gnulib xstrtol function. */\n";
7481 pr "static const char *xstrtol_suffixes = \"0kKMGTPEZY\";\n";
7484 (* list_commands function, which implements guestfish -h *)
7485 pr "void list_commands (void)\n";
7487 pr " printf (\" %%-16s %%s\\n\", _(\"Command\"), _(\"Description\"));\n";
7488 pr " list_builtin_commands ();\n";
7490 fun (name, _, _, flags, _, shortdesc, _) ->
7491 let name = replace_char name '_' '-' in
7492 pr " printf (\"%%-20s %%s\\n\", \"%s\", _(\"%s\"));\n"
7494 ) all_functions_sorted;
7495 pr " printf (\" %%s\\n\",";
7496 pr " _(\"Use -h <cmd> / help <cmd> to show detailed help for a command.\"));\n";
7500 (* display_command function, which implements guestfish -h cmd *)
7501 pr "void display_command (const char *cmd)\n";
7504 fun (name, style, _, flags, _, shortdesc, longdesc) ->
7505 let name2 = replace_char name '_' '-' in
7507 try find_map (function FishAlias n -> Some n | _ -> None) flags
7508 with Not_found -> name in
7509 let longdesc = replace_str longdesc "C<guestfs_" "C<" in
7511 match snd style with
7515 name2 (String.concat " " (List.map name_of_argt args)) in
7518 if List.mem ProtocolLimitWarning flags then
7519 ("\n\n" ^ protocol_limit_warning)
7522 (* For DangerWillRobinson commands, we should probably have
7523 * guestfish prompt before allowing you to use them (especially
7524 * in interactive mode). XXX
7528 if List.mem DangerWillRobinson flags then
7529 ("\n\n" ^ danger_will_robinson)
7534 match deprecation_notice flags with
7536 | Some txt -> "\n\n" ^ txt in
7538 let describe_alias =
7539 if name <> alias then
7540 sprintf "\n\nYou can use '%s' as an alias for this command." alias
7544 pr "STRCASEEQ (cmd, \"%s\")" name;
7545 if name <> name2 then
7546 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7547 if name <> alias then
7548 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7550 pr " pod2text (\"%s\", _(\"%s\"), %S);\n"
7552 ("=head1 SYNOPSIS\n\n " ^ synopsis ^ "\n\n" ^
7553 "=head1 DESCRIPTION\n\n" ^
7554 longdesc ^ warnings ^ describe_alias);
7557 pr " display_builtin_command (cmd);\n";
7561 let emit_print_list_function typ =
7562 pr "static void print_%s_list (struct guestfs_%s_list *%ss)\n"
7565 pr " unsigned int i;\n";
7567 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
7568 pr " printf (\"[%%d] = {\\n\", i);\n";
7569 pr " print_%s_indent (&%ss->val[i], \" \");\n" typ typ;
7570 pr " printf (\"}\\n\");\n";
7576 (* print_* functions *)
7580 List.exists (function (_, (FUUID|FBuffer)) -> true | _ -> false) cols in
7582 pr "static void print_%s_indent (struct guestfs_%s *%s, const char *indent)\n" typ typ typ;
7585 pr " unsigned int i;\n";
7591 pr " printf (\"%%s%s: %%s\\n\", indent, %s->%s);\n" name typ name
7593 pr " printf (\"%%s%s: \", indent);\n" name;
7594 pr " for (i = 0; i < 32; ++i)\n";
7595 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7596 pr " printf (\"\\n\");\n"
7598 pr " printf (\"%%s%s: \", indent);\n" name;
7599 pr " for (i = 0; i < %s->%s_len; ++i)\n" typ name;
7600 pr " if (c_isprint (%s->%s[i]))\n" typ name;
7601 pr " printf (\"%%c\", %s->%s[i]);\n" typ name;
7603 pr " printf (\"\\\\x%%02x\", %s->%s[i]);\n" typ name;
7604 pr " printf (\"\\n\");\n"
7605 | name, (FUInt64|FBytes) ->
7606 pr " printf (\"%%s%s: %%\" PRIu64 \"\\n\", indent, %s->%s);\n"
7609 pr " printf (\"%%s%s: %%\" PRIi64 \"\\n\", indent, %s->%s);\n"
7612 pr " printf (\"%%s%s: %%\" PRIu32 \"\\n\", indent, %s->%s);\n"
7615 pr " printf (\"%%s%s: %%\" PRIi32 \"\\n\", indent, %s->%s);\n"
7618 pr " printf (\"%%s%s: %%c\\n\", indent, %s->%s);\n"
7620 | name, FOptPercent ->
7621 pr " if (%s->%s >= 0) printf (\"%%s%s: %%g %%%%\\n\", indent, %s->%s);\n"
7622 typ name name typ name;
7623 pr " else printf (\"%%s%s: \\n\", indent);\n" name
7629 (* Emit a print_TYPE_list function definition only if that function is used. *)
7632 | typ, (RStructListOnly | RStructAndList) ->
7633 (* generate the function for typ *)
7634 emit_print_list_function typ
7635 | typ, _ -> () (* empty *)
7636 ) (rstructs_used_by all_functions);
7638 (* Emit a print_TYPE function definition only if that function is used. *)
7641 | typ, (RStructOnly | RStructAndList) ->
7642 pr "static void print_%s (struct guestfs_%s *%s)\n" typ typ typ;
7644 pr " print_%s_indent (%s, \"\");\n" typ typ;
7647 | typ, _ -> () (* empty *)
7648 ) (rstructs_used_by all_functions);
7650 (* run_<action> actions *)
7652 fun (name, style, _, flags, _, _, _) ->
7653 pr "static int run_%s (const char *cmd, int argc, char *argv[])\n" name;
7655 (match fst style with
7658 | RBool _ -> pr " int r;\n"
7659 | RInt64 _ -> pr " int64_t r;\n"
7660 | RConstString _ | RConstOptString _ -> pr " const char *r;\n"
7661 | RString _ -> pr " char *r;\n"
7662 | RStringList _ | RHashtable _ -> pr " char **r;\n"
7663 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ
7664 | RStructList (_, typ) -> pr " struct guestfs_%s_list *r;\n" typ
7667 pr " size_t size;\n";
7673 | OptString n -> pr " const char *%s;\n" n
7677 | FileOut n -> pr " char *%s;\n" n
7679 pr " const char *%s;\n" n;
7680 pr " size_t %s_size;\n" n
7681 | StringList n | DeviceList n -> pr " char **%s;\n" n
7682 | Bool n -> pr " int %s;\n" n
7683 | Int n -> pr " int %s;\n" n
7684 | Int64 n -> pr " int64_t %s;\n" n
7687 (* Check and convert parameters. *)
7688 let argc_expected = List.length (snd style) in
7689 pr " if (argc != %d) {\n" argc_expected;
7690 pr " fprintf (stderr, _(\"%%s should have %%d parameter(s)\\n\"), cmd, %d);\n"
7692 pr " fprintf (stderr, _(\"type 'help %%s' for help on %%s\\n\"), cmd, cmd);\n";
7696 let parse_integer fn fntyp rtyp range name i =
7698 pr " strtol_error xerr;\n";
7699 pr " %s r;\n" fntyp;
7701 pr " xerr = %s (argv[%d], NULL, 0, &r, xstrtol_suffixes);\n" fn i;
7702 pr " if (xerr != LONGINT_OK) {\n";
7703 pr " fprintf (stderr,\n";
7704 pr " _(\"%%s: %%s: invalid integer parameter (%%s returned %%d)\\n\"),\n";
7705 pr " cmd, \"%s\", \"%s\", xerr);\n" name fn;
7710 | Some (min, max, comment) ->
7711 pr " /* %s */\n" comment;
7712 pr " if (r < %s || r > %s) {\n" min max;
7713 pr " fprintf (stderr, _(\"%%s: %%s: integer out of range\\n\"), cmd, \"%s\");\n"
7717 pr " /* The check above should ensure this assignment does not overflow. */\n";
7719 pr " %s = r;\n" name;
7728 pr " %s = argv[%d];\n" name i
7730 | Dev_or_Path name ->
7731 pr " %s = resolve_win_path (argv[%d]);\n" name i;
7732 pr " if (%s == NULL) return -1;\n" name
7734 pr " %s = STRNEQ (argv[%d], \"\") ? argv[%d] : NULL;\n"
7737 pr " %s = argv[%d];\n" name i;
7738 pr " %s_size = strlen (argv[%d]);\n" name i
7740 pr " %s = file_in (argv[%d]);\n" name i;
7741 pr " if (%s == NULL) return -1;\n" name
7743 pr " %s = file_out (argv[%d]);\n" name i;
7744 pr " if (%s == NULL) return -1;\n" name
7745 | StringList name | DeviceList name ->
7746 pr " %s = parse_string_list (argv[%d]);\n" name i;
7747 pr " if (%s == NULL) return -1;\n" name;
7749 pr " %s = is_true (argv[%d]) ? 1 : 0;\n" name i
7752 let min = "(-(2LL<<30))"
7753 and max = "((2LL<<30)-1)"
7755 "The Int type in the generator is a signed 31 bit int." in
7756 Some (min, max, comment) in
7757 parse_integer "xstrtoll" "long long" "int" range name i
7759 parse_integer "xstrtoll" "long long" "int64_t" None name i
7762 (* Call C API function. *)
7763 pr " r = guestfs_%s " name;
7764 generate_c_call_args ~handle:"g" style;
7769 | Device name | String name
7770 | OptString name | Bool name
7771 | Int name | Int64 name
7772 | BufferIn name -> ()
7773 | Pathname name | Dev_or_Path name | FileOut name ->
7774 pr " free (%s);\n" name
7776 pr " free_file_in (%s);\n" name
7777 | StringList name | DeviceList name ->
7778 pr " free_strings (%s);\n" name
7781 (* Any output flags? *)
7783 let flags = filter_map (
7784 function FishOutput flag -> Some flag | _ -> None
7790 failwithf "%s: more than one FishOutput flag is not allowed" name in
7792 (* Check return value for errors and display command results. *)
7793 (match fst style with
7794 | RErr -> pr " return r;\n"
7796 pr " if (r == -1) return -1;\n";
7797 (match fish_output with
7799 pr " printf (\"%%d\\n\", r);\n";
7800 | Some FishOutputOctal ->
7801 pr " printf (\"%%s%%o\\n\", r != 0 ? \"0\" : \"\", r);\n";
7802 | Some FishOutputHexadecimal ->
7803 pr " printf (\"%%s%%x\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7806 pr " if (r == -1) return -1;\n";
7807 (match fish_output with
7809 pr " printf (\"%%\" PRIi64 \"\\n\", r);\n";
7810 | Some FishOutputOctal ->
7811 pr " printf (\"%%s%%\" PRIo64 \"\\n\", r != 0 ? \"0\" : \"\", r);\n";
7812 | Some FishOutputHexadecimal ->
7813 pr " printf (\"%%s%%\" PRIx64 \"\\n\", r != 0 ? \"0x\" : \"\", r);\n");
7816 pr " if (r == -1) return -1;\n";
7817 pr " if (r) printf (\"true\\n\"); else printf (\"false\\n\");\n";
7820 pr " if (r == NULL) return -1;\n";
7821 pr " printf (\"%%s\\n\", r);\n";
7823 | RConstOptString _ ->
7824 pr " printf (\"%%s\\n\", r ? : \"(null)\");\n";
7827 pr " if (r == NULL) return -1;\n";
7828 pr " printf (\"%%s\\n\", r);\n";
7832 pr " if (r == NULL) return -1;\n";
7833 pr " print_strings (r);\n";
7834 pr " free_strings (r);\n";
7836 | RStruct (_, typ) ->
7837 pr " if (r == NULL) return -1;\n";
7838 pr " print_%s (r);\n" typ;
7839 pr " guestfs_free_%s (r);\n" typ;
7841 | RStructList (_, typ) ->
7842 pr " if (r == NULL) return -1;\n";
7843 pr " print_%s_list (r);\n" typ;
7844 pr " guestfs_free_%s_list (r);\n" typ;
7847 pr " if (r == NULL) return -1;\n";
7848 pr " print_table (r);\n";
7849 pr " free_strings (r);\n";
7852 pr " if (r == NULL) return -1;\n";
7853 pr " if (full_write (1, r, size) != size) {\n";
7854 pr " perror (\"write\");\n";
7865 (* run_action function *)
7866 pr "int run_action (const char *cmd, int argc, char *argv[])\n";
7869 fun (name, _, _, flags, _, _, _) ->
7870 let name2 = replace_char name '_' '-' in
7872 try find_map (function FishAlias n -> Some n | _ -> None) flags
7873 with Not_found -> name in
7875 pr "STRCASEEQ (cmd, \"%s\")" name;
7876 if name <> name2 then
7877 pr " || STRCASEEQ (cmd, \"%s\")" name2;
7878 if name <> alias then
7879 pr " || STRCASEEQ (cmd, \"%s\")" alias;
7881 pr " return run_%s (cmd, argc, argv);\n" name;
7885 pr " fprintf (stderr, _(\"%%s: unknown command\\n\"), cmd);\n";
7886 pr " if (command_num == 1)\n";
7887 pr " extended_help_message ();\n";
7894 (* Readline completion for guestfish. *)
7895 and generate_fish_completion () =
7896 generate_header CStyle GPLv2plus;
7900 fun (_, _, _, flags, _, _, _) -> not (List.mem NotInFish flags)
7910 #ifdef HAVE_LIBREADLINE
7911 #include <readline/readline.h>
7916 #ifdef HAVE_LIBREADLINE
7918 static const char *const commands[] = {
7919 BUILTIN_COMMANDS_FOR_COMPLETION,
7922 (* Get the commands, including the aliases. They don't need to be
7923 * sorted - the generator() function just does a dumb linear search.
7927 fun (name, _, _, flags, _, _, _) ->
7928 let name2 = replace_char name '_' '-' in
7930 try find_map (function FishAlias n -> Some n | _ -> None) flags
7931 with Not_found -> name in
7933 if name <> alias then [name2; alias] else [name2]
7935 let commands = List.flatten commands in
7937 List.iter (pr " \"%s\",\n") commands;
7943 generator (const char *text, int state)
7945 static int index, len;
7950 len = strlen (text);
7953 rl_attempted_completion_over = 1;
7955 while ((name = commands[index]) != NULL) {
7957 if (STRCASEEQLEN (name, text, len))
7958 return strdup (name);
7964 #endif /* HAVE_LIBREADLINE */
7966 #ifdef HAVE_RL_COMPLETION_MATCHES
7967 #define RL_COMPLETION_MATCHES rl_completion_matches
7969 #ifdef HAVE_COMPLETION_MATCHES
7970 #define RL_COMPLETION_MATCHES completion_matches
7972 #endif /* else just fail if we don't have either symbol */
7975 do_completion (const char *text, int start, int end)
7977 char **matches = NULL;
7979 #ifdef HAVE_LIBREADLINE
7980 rl_completion_append_character = ' ';
7983 matches = RL_COMPLETION_MATCHES (text, generator);
7984 else if (complete_dest_paths)
7985 matches = RL_COMPLETION_MATCHES (text, complete_dest_paths_generator);
7992 (* Generate the POD documentation for guestfish. *)
7993 and generate_fish_actions_pod () =
7994 let all_functions_sorted =
7996 fun (_, _, _, flags, _, _, _) ->
7997 not (List.mem NotInFish flags || List.mem NotInDocs flags)
7998 ) all_functions_sorted in
8000 let rex = Str.regexp "C<guestfs_\\([^>]+\\)>" in
8003 fun (name, style, _, flags, _, _, longdesc) ->
8005 Str.global_substitute rex (
8008 try Str.matched_group 1 s
8010 failwithf "error substituting C<guestfs_...> in longdesc of function %s" name in
8011 "C<" ^ replace_char sub '_' '-' ^ ">"
8013 let name = replace_char name '_' '-' in
8015 try find_map (function FishAlias n -> Some n | _ -> None) flags
8016 with Not_found -> name in
8018 pr "=head2 %s" name;
8019 if name <> alias then
8026 | Pathname n | Device n | Dev_or_Path n | String n -> pr " %s" n
8027 | OptString n -> pr " %s" n
8028 | StringList n | DeviceList n -> pr " '%s ...'" n
8029 | Bool _ -> pr " true|false"
8030 | Int n -> pr " %s" n
8031 | Int64 n -> pr " %s" n
8032 | FileIn n | FileOut n -> pr " (%s|-)" n
8033 | BufferIn n -> pr " %s" n
8037 pr "%s\n\n" longdesc;
8039 if List.exists (function FileIn _ | FileOut _ -> true
8040 | _ -> false) (snd style) then
8041 pr "Use C<-> instead of a filename to read/write from stdin/stdout.\n\n";
8043 if List.mem ProtocolLimitWarning flags then
8044 pr "%s\n\n" protocol_limit_warning;
8046 if List.mem DangerWillRobinson flags then
8047 pr "%s\n\n" danger_will_robinson;
8049 match deprecation_notice flags with
8051 | Some txt -> pr "%s\n\n" txt
8052 ) all_functions_sorted
8054 (* Generate a C function prototype. *)
8055 and generate_prototype ?(extern = true) ?(static = false) ?(semicolon = true)
8056 ?(single_line = false) ?(newline = false) ?(in_daemon = false)
8058 ?handle name style =
8059 if extern then pr "extern ";
8060 if static then pr "static ";
8061 (match fst style with
8063 | RInt _ -> pr "int "
8064 | RInt64 _ -> pr "int64_t "
8065 | RBool _ -> pr "int "
8066 | RConstString _ | RConstOptString _ -> pr "const char *"
8067 | RString _ | RBufferOut _ -> pr "char *"
8068 | RStringList _ | RHashtable _ -> pr "char **"
8069 | RStruct (_, typ) ->
8070 if not in_daemon then pr "struct guestfs_%s *" typ
8071 else pr "guestfs_int_%s *" typ
8072 | RStructList (_, typ) ->
8073 if not in_daemon then pr "struct guestfs_%s_list *" typ
8074 else pr "guestfs_int_%s_list *" typ
8076 let is_RBufferOut = match fst style with RBufferOut _ -> true | _ -> false in
8077 pr "%s%s (" prefix name;
8078 if handle = None && List.length (snd style) = 0 && not is_RBufferOut then
8081 let comma = ref false in
8084 | Some handle -> pr "guestfs_h *%s" handle; comma := true
8088 if single_line then pr ", " else pr ",\n\t\t"
8095 | Device n | Dev_or_Path n
8099 pr "const char *%s" n
8100 | StringList n | DeviceList n ->
8102 pr "char *const *%s" n
8103 | Bool n -> next (); pr "int %s" n
8104 | Int n -> next (); pr "int %s" n
8105 | Int64 n -> next (); pr "int64_t %s" n
8108 if not in_daemon then (next (); pr "const char *%s" n)
8111 pr "const char *%s" n;
8113 pr "size_t %s_size" n
8115 if is_RBufferOut then (next (); pr "size_t *size_r");
8118 if semicolon then pr ";";
8119 if newline then pr "\n"
8121 (* Generate C call arguments, eg "(handle, foo, bar)" *)
8122 and generate_c_call_args ?handle ?(decl = false) style =
8124 let comma = ref false in
8126 if !comma then pr ", ";
8131 | Some handle -> pr "%s" handle; comma := true
8137 pr "%s, %s_size" n n
8140 pr "%s" (name_of_argt arg)
8142 (* For RBufferOut calls, add implicit &size parameter. *)
8144 match fst style with
8152 (* Generate the OCaml bindings interface. *)
8153 and generate_ocaml_mli () =
8154 generate_header OCamlStyle LGPLv2plus;
8157 (** For API documentation you should refer to the C API
8158 in the guestfs(3) manual page. The OCaml API uses almost
8159 exactly the same calls. *)
8162 (** A [guestfs_h] handle. *)
8164 exception Error of string
8165 (** This exception is raised when there is an error. *)
8167 exception Handle_closed of string
8168 (** This exception is raised if you use a {!Guestfs.t} handle
8169 after calling {!close} on it. The string is the name of
8172 val create : unit -> t
8173 (** Create a {!Guestfs.t} handle. *)
8175 val close : t -> unit
8176 (** Close the {!Guestfs.t} handle and free up all resources used
8179 Handles are closed by the garbage collector when they become
8180 unreferenced, but callers can call this in order to provide
8181 predictable cleanup. *)
8184 generate_ocaml_structure_decls ();
8188 fun (name, style, _, _, _, shortdesc, _) ->
8189 generate_ocaml_prototype name style;
8190 pr "(** %s *)\n" shortdesc;
8192 ) all_functions_sorted
8194 (* Generate the OCaml bindings implementation. *)
8195 and generate_ocaml_ml () =
8196 generate_header OCamlStyle LGPLv2plus;
8201 exception Error of string
8202 exception Handle_closed of string
8204 external create : unit -> t = \"ocaml_guestfs_create\"
8205 external close : t -> unit = \"ocaml_guestfs_close\"
8207 (* Give the exceptions names, so they can be raised from the C code. *)
8209 Callback.register_exception \"ocaml_guestfs_error\" (Error \"\");
8210 Callback.register_exception \"ocaml_guestfs_closed\" (Handle_closed \"\")
8214 generate_ocaml_structure_decls ();
8218 fun (name, style, _, _, _, shortdesc, _) ->
8219 generate_ocaml_prototype ~is_external:true name style;
8220 ) all_functions_sorted
8222 (* Generate the OCaml bindings C implementation. *)
8223 and generate_ocaml_c () =
8224 generate_header CStyle LGPLv2plus;
8231 #include <caml/config.h>
8232 #include <caml/alloc.h>
8233 #include <caml/callback.h>
8234 #include <caml/fail.h>
8235 #include <caml/memory.h>
8236 #include <caml/mlvalues.h>
8237 #include <caml/signals.h>
8239 #include <guestfs.h>
8241 #include \"guestfs_c.h\"
8243 /* Copy a hashtable of string pairs into an assoc-list. We return
8244 * the list in reverse order, but hashtables aren't supposed to be
8247 static CAMLprim value
8248 copy_table (char * const * argv)
8251 CAMLlocal5 (rv, pairv, kv, vv, cons);
8255 for (i = 0; argv[i] != NULL; i += 2) {
8256 kv = caml_copy_string (argv[i]);
8257 vv = caml_copy_string (argv[i+1]);
8258 pairv = caml_alloc (2, 0);
8259 Store_field (pairv, 0, kv);
8260 Store_field (pairv, 1, vv);
8261 cons = caml_alloc (2, 0);
8262 Store_field (cons, 1, rv);
8264 Store_field (cons, 0, pairv);
8272 (* Struct copy functions. *)
8274 let emit_ocaml_copy_list_function typ =
8275 pr "static CAMLprim value\n";
8276 pr "copy_%s_list (const struct guestfs_%s_list *%ss)\n" typ typ typ;
8278 pr " CAMLparam0 ();\n";
8279 pr " CAMLlocal2 (rv, v);\n";
8280 pr " unsigned int i;\n";
8282 pr " if (%ss->len == 0)\n" typ;
8283 pr " CAMLreturn (Atom (0));\n";
8285 pr " rv = caml_alloc (%ss->len, 0);\n" typ;
8286 pr " for (i = 0; i < %ss->len; ++i) {\n" typ;
8287 pr " v = copy_%s (&%ss->val[i]);\n" typ typ;
8288 pr " caml_modify (&Field (rv, i), v);\n";
8290 pr " CAMLreturn (rv);\n";
8298 let has_optpercent_col =
8299 List.exists (function (_, FOptPercent) -> true | _ -> false) cols in
8301 pr "static CAMLprim value\n";
8302 pr "copy_%s (const struct guestfs_%s *%s)\n" typ typ typ;
8304 pr " CAMLparam0 ();\n";
8305 if has_optpercent_col then
8306 pr " CAMLlocal3 (rv, v, v2);\n"
8308 pr " CAMLlocal2 (rv, v);\n";
8310 pr " rv = caml_alloc (%d, 0);\n" (List.length cols);
8315 pr " v = caml_copy_string (%s->%s);\n" typ name
8317 pr " v = caml_alloc_string (%s->%s_len);\n" typ name;
8318 pr " memcpy (String_val (v), %s->%s, %s->%s_len);\n"
8321 pr " v = caml_alloc_string (32);\n";
8322 pr " memcpy (String_val (v), %s->%s, 32);\n" typ name
8323 | name, (FBytes|FInt64|FUInt64) ->
8324 pr " v = caml_copy_int64 (%s->%s);\n" typ name
8325 | name, (FInt32|FUInt32) ->
8326 pr " v = caml_copy_int32 (%s->%s);\n" typ name
8327 | name, FOptPercent ->
8328 pr " if (%s->%s >= 0) { /* Some %s */\n" typ name name;
8329 pr " v2 = caml_copy_double (%s->%s);\n" typ name;
8330 pr " v = caml_alloc (1, 0);\n";
8331 pr " Store_field (v, 0, v2);\n";
8332 pr " } else /* None */\n";
8333 pr " v = Val_int (0);\n";
8335 pr " v = Val_int (%s->%s);\n" typ name
8337 pr " Store_field (rv, %d, v);\n" i
8339 pr " CAMLreturn (rv);\n";
8344 (* Emit a copy_TYPE_list function definition only if that function is used. *)
8347 | typ, (RStructListOnly | RStructAndList) ->
8348 (* generate the function for typ *)
8349 emit_ocaml_copy_list_function typ
8350 | typ, _ -> () (* empty *)
8351 ) (rstructs_used_by all_functions);
8355 fun (name, style, _, _, _, _, _) ->
8356 pr "/* Automatically generated wrapper for function\n";
8358 generate_ocaml_prototype name style;
8363 "gv" :: List.map (fun arg -> name_of_argt arg ^ "v") (snd style) in
8365 let needs_extra_vs =
8366 match fst style with RConstOptString _ -> true | _ -> false in
8368 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8369 pr "CAMLprim value ocaml_guestfs_%s (value %s" name (List.hd params);
8370 List.iter (pr ", value %s") (List.tl params); pr ");\n";
8373 pr "CAMLprim value\n";
8374 pr "ocaml_guestfs_%s (value %s" name (List.hd params);
8375 List.iter (pr ", value %s") (List.tl params);
8380 | [p1; p2; p3; p4; p5] ->
8381 pr " CAMLparam5 (%s);\n" (String.concat ", " params)
8382 | p1 :: p2 :: p3 :: p4 :: p5 :: rest ->
8383 pr " CAMLparam5 (%s);\n" (String.concat ", " [p1; p2; p3; p4; p5]);
8384 pr " CAMLxparam%d (%s);\n"
8385 (List.length rest) (String.concat ", " rest)
8387 pr " CAMLparam%d (%s);\n" (List.length ps) (String.concat ", " ps)
8389 if not needs_extra_vs then
8390 pr " CAMLlocal1 (rv);\n"
8392 pr " CAMLlocal3 (rv, v, v2);\n";
8395 pr " guestfs_h *g = Guestfs_val (gv);\n";
8396 pr " if (g == NULL)\n";
8397 pr " ocaml_guestfs_raise_closed (\"%s\");\n" name;
8403 | Device n | Dev_or_Path n
8407 pr " const char *%s = String_val (%sv);\n" n n
8409 pr " const char *%s =\n" n;
8410 pr " %sv != Val_int (0) ? String_val (Field (%sv, 0)) : NULL;\n"
8413 pr " const char *%s = String_val (%sv);\n" n n;
8414 pr " size_t %s_size = caml_string_length (%sv);\n" n n
8415 | StringList n | DeviceList n ->
8416 pr " char **%s = ocaml_guestfs_strings_val (g, %sv);\n" n n
8418 pr " int %s = Bool_val (%sv);\n" n n
8420 pr " int %s = Int_val (%sv);\n" n n
8422 pr " int64_t %s = Int64_val (%sv);\n" n n
8425 match fst style with
8426 | RErr -> pr " int r;\n"; "-1"
8427 | RInt _ -> pr " int r;\n"; "-1"
8428 | RInt64 _ -> pr " int64_t r;\n"; "-1"
8429 | RBool _ -> pr " int r;\n"; "-1"
8430 | RConstString _ | RConstOptString _ ->
8431 pr " const char *r;\n"; "NULL"
8432 | RString _ -> pr " char *r;\n"; "NULL"
8437 | RStruct (_, typ) ->
8438 pr " struct guestfs_%s *r;\n" typ; "NULL"
8439 | RStructList (_, typ) ->
8440 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
8447 pr " size_t size;\n";
8451 pr " caml_enter_blocking_section ();\n";
8452 pr " r = guestfs_%s " name;
8453 generate_c_call_args ~handle:"g" style;
8455 pr " caml_leave_blocking_section ();\n";
8459 | StringList n | DeviceList n ->
8460 pr " ocaml_guestfs_free_strings (%s);\n" n;
8461 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8462 | Bool _ | Int _ | Int64 _
8463 | FileIn _ | FileOut _ | BufferIn _ -> ()
8466 pr " if (r == %s)\n" error_code;
8467 pr " ocaml_guestfs_raise_error (g, \"%s\");\n" name;
8470 (match fst style with
8471 | RErr -> pr " rv = Val_unit;\n"
8472 | RInt _ -> pr " rv = Val_int (r);\n"
8474 pr " rv = caml_copy_int64 (r);\n"
8475 | RBool _ -> pr " rv = Val_bool (r);\n"
8477 pr " rv = caml_copy_string (r);\n"
8478 | RConstOptString _ ->
8479 pr " if (r) { /* Some string */\n";
8480 pr " v = caml_alloc (1, 0);\n";
8481 pr " v2 = caml_copy_string (r);\n";
8482 pr " Store_field (v, 0, v2);\n";
8483 pr " } else /* None */\n";
8484 pr " v = Val_int (0);\n";
8486 pr " rv = caml_copy_string (r);\n";
8489 pr " rv = caml_copy_string_array ((const char **) r);\n";
8490 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8492 | RStruct (_, typ) ->
8493 pr " rv = copy_%s (r);\n" typ;
8494 pr " guestfs_free_%s (r);\n" typ;
8495 | RStructList (_, typ) ->
8496 pr " rv = copy_%s_list (r);\n" typ;
8497 pr " guestfs_free_%s_list (r);\n" typ;
8499 pr " rv = copy_table (r);\n";
8500 pr " for (i = 0; r[i] != NULL; ++i) free (r[i]);\n";
8503 pr " rv = caml_alloc_string (size);\n";
8504 pr " memcpy (String_val (rv), r, size);\n";
8507 pr " CAMLreturn (rv);\n";
8511 if List.length params > 5 then (
8512 pr "/* Emit prototype to appease gcc's -Wmissing-prototypes. */\n";
8513 pr "CAMLprim value ";
8514 pr "ocaml_guestfs_%s_byte (value *argv, int argn);\n" name;
8515 pr "CAMLprim value\n";
8516 pr "ocaml_guestfs_%s_byte (value *argv, int argn)\n" name;
8518 pr " return ocaml_guestfs_%s (argv[0]" name;
8519 iteri (fun i _ -> pr ", argv[%d]" i) (List.tl params);
8524 ) all_functions_sorted
8526 and generate_ocaml_structure_decls () =
8529 pr "type %s = {\n" typ;
8532 | name, FString -> pr " %s : string;\n" name
8533 | name, FBuffer -> pr " %s : string;\n" name
8534 | name, FUUID -> pr " %s : string;\n" name
8535 | name, (FBytes|FInt64|FUInt64) -> pr " %s : int64;\n" name
8536 | name, (FInt32|FUInt32) -> pr " %s : int32;\n" name
8537 | name, FChar -> pr " %s : char;\n" name
8538 | name, FOptPercent -> pr " %s : float option;\n" name
8544 and generate_ocaml_prototype ?(is_external = false) name style =
8545 if is_external then pr "external " else pr "val ";
8546 pr "%s : t -> " name;
8549 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _
8550 | BufferIn _ -> pr "string -> "
8551 | OptString _ -> pr "string option -> "
8552 | StringList _ | DeviceList _ -> pr "string array -> "
8553 | Bool _ -> pr "bool -> "
8554 | Int _ -> pr "int -> "
8555 | Int64 _ -> pr "int64 -> "
8557 (match fst style with
8558 | RErr -> pr "unit" (* all errors are turned into exceptions *)
8559 | RInt _ -> pr "int"
8560 | RInt64 _ -> pr "int64"
8561 | RBool _ -> pr "bool"
8562 | RConstString _ -> pr "string"
8563 | RConstOptString _ -> pr "string option"
8564 | RString _ | RBufferOut _ -> pr "string"
8565 | RStringList _ -> pr "string array"
8566 | RStruct (_, typ) -> pr "%s" typ
8567 | RStructList (_, typ) -> pr "%s array" typ
8568 | RHashtable _ -> pr "(string * string) list"
8570 if is_external then (
8572 if List.length (snd style) + 1 > 5 then
8573 pr "\"ocaml_guestfs_%s_byte\" " name;
8574 pr "\"ocaml_guestfs_%s\"" name
8578 (* Generate Perl xs code, a sort of crazy variation of C with macros. *)
8579 and generate_perl_xs () =
8580 generate_header CStyle LGPLv2plus;
8583 #include \"EXTERN.h\"
8587 #include <guestfs.h>
8590 #define PRId64 \"lld\"
8594 my_newSVll(long long val) {
8595 #ifdef USE_64_BIT_ALL
8596 return newSViv(val);
8600 len = snprintf(buf, 100, \"%%\" PRId64, val);
8601 return newSVpv(buf, len);
8606 #define PRIu64 \"llu\"
8610 my_newSVull(unsigned long long val) {
8611 #ifdef USE_64_BIT_ALL
8612 return newSVuv(val);
8616 len = snprintf(buf, 100, \"%%\" PRIu64, val);
8617 return newSVpv(buf, len);
8621 /* http://www.perlmonks.org/?node_id=680842 */
8623 XS_unpack_charPtrPtr (SV *arg) {
8628 if (!arg || !SvOK (arg) || !SvROK (arg) || SvTYPE (SvRV (arg)) != SVt_PVAV)
8629 croak (\"array reference expected\");
8631 av = (AV *)SvRV (arg);
8632 ret = malloc ((av_len (av) + 1 + 1) * sizeof (char *));
8634 croak (\"malloc failed\");
8636 for (i = 0; i <= av_len (av); i++) {
8637 SV **elem = av_fetch (av, i, 0);
8639 if (!elem || !*elem)
8640 croak (\"missing element in list\");
8642 ret[i] = SvPV_nolen (*elem);
8650 MODULE = Sys::Guestfs PACKAGE = Sys::Guestfs
8657 RETVAL = guestfs_create ();
8659 croak (\"could not create guestfs handle\");
8660 guestfs_set_error_handler (RETVAL, NULL, NULL);
8673 fun (name, style, _, _, _, _, _) ->
8674 (match fst style with
8675 | RErr -> pr "void\n"
8676 | RInt _ -> pr "SV *\n"
8677 | RInt64 _ -> pr "SV *\n"
8678 | RBool _ -> pr "SV *\n"
8679 | RConstString _ -> pr "SV *\n"
8680 | RConstOptString _ -> pr "SV *\n"
8681 | RString _ -> pr "SV *\n"
8682 | RBufferOut _ -> pr "SV *\n"
8684 | RStruct _ | RStructList _
8686 pr "void\n" (* all lists returned implictly on the stack *)
8688 (* Call and arguments. *)
8691 fun arg -> pr ", %s" (name_of_argt arg)
8694 pr " guestfs_h *g;\n";
8698 | Pathname n | Device n | Dev_or_Path n | String n
8699 | FileIn n | FileOut n ->
8702 pr " char *%s;\n" n;
8703 pr " size_t %s_size = SvCUR (ST(%d));\n" n (i+1)
8705 (* http://www.perlmonks.org/?node_id=554277
8706 * Note that the implicit handle argument means we have
8707 * to add 1 to the ST(x) operator.
8709 pr " char *%s = SvOK(ST(%d)) ? SvPV_nolen(ST(%d)) : NULL;\n" n (i+1) (i+1)
8710 | StringList n | DeviceList n -> pr " char **%s;\n" n
8711 | Bool n -> pr " int %s;\n" n
8712 | Int n -> pr " int %s;\n" n
8713 | Int64 n -> pr " int64_t %s;\n" n
8716 let do_cleanups () =
8719 | Pathname _ | Device _ | Dev_or_Path _ | String _ | OptString _
8720 | Bool _ | Int _ | Int64 _
8721 | FileIn _ | FileOut _
8723 | StringList n | DeviceList n -> pr " free (%s);\n" n
8728 (match fst style with
8733 pr " r = guestfs_%s " name;
8734 generate_c_call_args ~handle:"g" style;
8737 pr " if (r == -1)\n";
8738 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8744 pr " %s = guestfs_%s " n name;
8745 generate_c_call_args ~handle:"g" style;
8748 pr " if (%s == -1)\n" n;
8749 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8750 pr " RETVAL = newSViv (%s);\n" n;
8755 pr " int64_t %s;\n" n;
8757 pr " %s = guestfs_%s " n name;
8758 generate_c_call_args ~handle:"g" style;
8761 pr " if (%s == -1)\n" n;
8762 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8763 pr " RETVAL = my_newSVll (%s);\n" n;
8768 pr " const char *%s;\n" n;
8770 pr " %s = guestfs_%s " n name;
8771 generate_c_call_args ~handle:"g" style;
8774 pr " if (%s == NULL)\n" n;
8775 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8776 pr " RETVAL = newSVpv (%s, 0);\n" n;
8779 | RConstOptString n ->
8781 pr " const char *%s;\n" n;
8783 pr " %s = guestfs_%s " n name;
8784 generate_c_call_args ~handle:"g" style;
8787 pr " if (%s == NULL)\n" n;
8788 pr " RETVAL = &PL_sv_undef;\n";
8790 pr " RETVAL = newSVpv (%s, 0);\n" n;
8795 pr " char *%s;\n" n;
8797 pr " %s = guestfs_%s " n name;
8798 generate_c_call_args ~handle:"g" style;
8801 pr " if (%s == NULL)\n" n;
8802 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8803 pr " RETVAL = newSVpv (%s, 0);\n" n;
8804 pr " free (%s);\n" n;
8807 | RStringList n | RHashtable n ->
8809 pr " char **%s;\n" n;
8812 pr " %s = guestfs_%s " n name;
8813 generate_c_call_args ~handle:"g" style;
8816 pr " if (%s == NULL)\n" n;
8817 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8818 pr " for (n = 0; %s[n] != NULL; ++n) /**/;\n" n;
8819 pr " EXTEND (SP, n);\n";
8820 pr " for (i = 0; i < n; ++i) {\n";
8821 pr " PUSHs (sv_2mortal (newSVpv (%s[i], 0)));\n" n;
8822 pr " free (%s[i]);\n" n;
8824 pr " free (%s);\n" n;
8825 | RStruct (n, typ) ->
8826 let cols = cols_of_struct typ in
8827 generate_perl_struct_code typ cols name style n do_cleanups
8828 | RStructList (n, typ) ->
8829 let cols = cols_of_struct typ in
8830 generate_perl_struct_list_code typ cols name style n do_cleanups
8833 pr " char *%s;\n" n;
8834 pr " size_t size;\n";
8836 pr " %s = guestfs_%s " n name;
8837 generate_c_call_args ~handle:"g" style;
8840 pr " if (%s == NULL)\n" n;
8841 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8842 pr " RETVAL = newSVpvn (%s, size);\n" n;
8843 pr " free (%s);\n" n;
8851 and generate_perl_struct_list_code typ cols name style n do_cleanups =
8853 pr " struct guestfs_%s_list *%s;\n" typ n;
8857 pr " %s = guestfs_%s " n name;
8858 generate_c_call_args ~handle:"g" style;
8861 pr " if (%s == NULL)\n" n;
8862 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8863 pr " EXTEND (SP, %s->len);\n" n;
8864 pr " for (i = 0; i < %s->len; ++i) {\n" n;
8865 pr " hv = newHV ();\n";
8869 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 0), 0);\n"
8870 name (String.length name) n name
8872 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (%s->val[i].%s, 32), 0);\n"
8873 name (String.length name) n name
8875 pr " (void) hv_store (hv, \"%s\", %d, newSVpvn (%s->val[i].%s, %s->val[i].%s_len), 0);\n"
8876 name (String.length name) n name n name
8877 | name, (FBytes|FUInt64) ->
8878 pr " (void) hv_store (hv, \"%s\", %d, my_newSVull (%s->val[i].%s), 0);\n"
8879 name (String.length name) n name
8881 pr " (void) hv_store (hv, \"%s\", %d, my_newSVll (%s->val[i].%s), 0);\n"
8882 name (String.length name) n name
8883 | name, (FInt32|FUInt32) ->
8884 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8885 name (String.length name) n name
8887 pr " (void) hv_store (hv, \"%s\", %d, newSVpv (&%s->val[i].%s, 1), 0);\n"
8888 name (String.length name) n name
8889 | name, FOptPercent ->
8890 pr " (void) hv_store (hv, \"%s\", %d, newSVnv (%s->val[i].%s), 0);\n"
8891 name (String.length name) n name
8893 pr " PUSHs (sv_2mortal (newRV ((SV *) hv)));\n";
8895 pr " guestfs_free_%s_list (%s);\n" typ n
8897 and generate_perl_struct_code typ cols name style n do_cleanups =
8899 pr " struct guestfs_%s *%s;\n" typ n;
8901 pr " %s = guestfs_%s " n name;
8902 generate_c_call_args ~handle:"g" style;
8905 pr " if (%s == NULL)\n" n;
8906 pr " croak (\"%%s\", guestfs_last_error (g));\n";
8907 pr " EXTEND (SP, 2 * %d);\n" (List.length cols);
8909 fun ((name, _) as col) ->
8910 pr " PUSHs (sv_2mortal (newSVpv (\"%s\", 0)));\n" name;
8914 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 0)));\n"
8917 pr " PUSHs (sv_2mortal (newSVpvn (%s->%s, %s->%s_len)));\n"
8920 pr " PUSHs (sv_2mortal (newSVpv (%s->%s, 32)));\n"
8922 | name, (FBytes|FUInt64) ->
8923 pr " PUSHs (sv_2mortal (my_newSVull (%s->%s)));\n"
8926 pr " PUSHs (sv_2mortal (my_newSVll (%s->%s)));\n"
8928 | name, (FInt32|FUInt32) ->
8929 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8932 pr " PUSHs (sv_2mortal (newSVpv (&%s->%s, 1)));\n"
8934 | name, FOptPercent ->
8935 pr " PUSHs (sv_2mortal (newSVnv (%s->%s)));\n"
8938 pr " free (%s);\n" n
8940 (* Generate Sys/Guestfs.pm. *)
8941 and generate_perl_pm () =
8942 generate_header HashStyle LGPLv2plus;
8949 Sys::Guestfs - Perl bindings for libguestfs
8955 my $h = Sys::Guestfs->new ();
8956 $h->add_drive ('guest.img');
8958 $h->mount ('/dev/sda1', '/');
8959 $h->touch ('/hello');
8964 The C<Sys::Guestfs> module provides a Perl XS binding to the
8965 libguestfs API for examining and modifying virtual machine
8968 Amongst the things this is good for: making batch configuration
8969 changes to guests, getting disk used/free statistics (see also:
8970 virt-df), migrating between virtualization systems (see also:
8971 virt-p2v), performing partial backups, performing partial guest
8972 clones, cloning guests and changing registry/UUID/hostname info, and
8975 Libguestfs uses Linux kernel and qemu code, and can access any type of
8976 guest filesystem that Linux and qemu can, including but not limited
8977 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
8978 schemes, qcow, qcow2, vmdk.
8980 Libguestfs provides ways to enumerate guest storage (eg. partitions,
8981 LVs, what filesystem is in each LV, etc.). It can also run commands
8982 in the context of the guest. Also you can access filesystems over
8985 See also L<Sys::Guestfs::Lib(3)> for a set of useful library
8986 functions for using libguestfs from Perl, including integration
8991 All errors turn into calls to C<croak> (see L<Carp(3)>).
8999 package Sys::Guestfs;
9004 # This version number changes whenever a new function
9005 # is added to the libguestfs API. It is not directly
9006 # related to the libguestfs version number.
9007 use vars qw($VERSION);
9011 XSLoader::load ('Sys::Guestfs');
9013 =item $h = Sys::Guestfs->new ();
9015 Create a new guestfs handle.
9021 my $class = ref ($proto) || $proto;
9023 my $self = Sys::Guestfs::_create ();
9024 bless $self, $class;
9030 (* Actions. We only need to print documentation for these as
9031 * they are pulled in from the XS code automatically.
9034 fun (name, style, _, flags, _, _, longdesc) ->
9035 if not (List.mem NotInDocs flags) then (
9036 let longdesc = replace_str longdesc "C<guestfs_" "C<$h-E<gt>" in
9038 generate_perl_prototype name style;
9040 pr "%s\n\n" longdesc;
9041 if List.mem ProtocolLimitWarning flags then
9042 pr "%s\n\n" protocol_limit_warning;
9043 if List.mem DangerWillRobinson flags then
9044 pr "%s\n\n" danger_will_robinson;
9045 match deprecation_notice flags with
9047 | Some txt -> pr "%s\n\n" txt
9049 ) all_functions_sorted;
9061 Copyright (C) %s Red Hat Inc.
9065 Please see the file COPYING.LIB for the full license.
9071 L<http://libguestfs.org>,
9072 L<Sys::Guestfs::Lib(3)>.
9077 and generate_perl_prototype name style =
9078 (match fst style with
9086 | RBufferOut n -> pr "$%s = " n
9088 | RHashtable n -> pr "%%%s = " n
9090 | RStructList (n,_) -> pr "@%s = " n
9093 let comma = ref false in
9096 if !comma then pr ", ";
9099 | Pathname n | Device n | Dev_or_Path n | String n
9100 | OptString n | Bool n | Int n | Int64 n | FileIn n | FileOut n
9103 | StringList n | DeviceList n ->
9108 (* Generate Python C module. *)
9109 and generate_python_c () =
9110 generate_header CStyle LGPLv2plus;
9113 #define PY_SSIZE_T_CLEAN 1
9116 #if PY_VERSION_HEX < 0x02050000
9117 typedef int Py_ssize_t;
9118 #define PY_SSIZE_T_MAX INT_MAX
9119 #define PY_SSIZE_T_MIN INT_MIN
9126 #include \"guestfs.h\"
9134 get_handle (PyObject *obj)
9137 assert (obj != Py_None);
9138 return ((Pyguestfs_Object *) obj)->g;
9142 put_handle (guestfs_h *g)
9146 PyCObject_FromVoidPtrAndDesc ((void *) g, (char *) \"guestfs_h\", NULL);
9149 /* This list should be freed (but not the strings) after use. */
9151 get_string_list (PyObject *obj)
9158 if (!PyList_Check (obj)) {
9159 PyErr_SetString (PyExc_RuntimeError, \"expecting a list parameter\");
9163 len = PyList_Size (obj);
9164 r = malloc (sizeof (char *) * (len+1));
9166 PyErr_SetString (PyExc_RuntimeError, \"get_string_list: out of memory\");
9170 for (i = 0; i < len; ++i)
9171 r[i] = PyString_AsString (PyList_GetItem (obj, i));
9178 put_string_list (char * const * const argv)
9183 for (argc = 0; argv[argc] != NULL; ++argc)
9186 list = PyList_New (argc);
9187 for (i = 0; i < argc; ++i)
9188 PyList_SetItem (list, i, PyString_FromString (argv[i]));
9194 put_table (char * const * const argv)
9196 PyObject *list, *item;
9199 for (argc = 0; argv[argc] != NULL; ++argc)
9202 list = PyList_New (argc >> 1);
9203 for (i = 0; i < argc; i += 2) {
9204 item = PyTuple_New (2);
9205 PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
9206 PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
9207 PyList_SetItem (list, i >> 1, item);
9214 free_strings (char **argv)
9218 for (argc = 0; argv[argc] != NULL; ++argc)
9224 py_guestfs_create (PyObject *self, PyObject *args)
9228 g = guestfs_create ();
9230 PyErr_SetString (PyExc_RuntimeError,
9231 \"guestfs.create: failed to allocate handle\");
9234 guestfs_set_error_handler (g, NULL, NULL);
9235 return put_handle (g);
9239 py_guestfs_close (PyObject *self, PyObject *args)
9244 if (!PyArg_ParseTuple (args, (char *) \"O:guestfs_close\", &py_g))
9246 g = get_handle (py_g);
9250 Py_INCREF (Py_None);
9256 let emit_put_list_function typ =
9257 pr "static PyObject *\n";
9258 pr "put_%s_list (struct guestfs_%s_list *%ss)\n" typ typ typ;
9260 pr " PyObject *list;\n";
9263 pr " list = PyList_New (%ss->len);\n" typ;
9264 pr " for (i = 0; i < %ss->len; ++i)\n" typ;
9265 pr " PyList_SetItem (list, i, put_%s (&%ss->val[i]));\n" typ typ;
9266 pr " return list;\n";
9271 (* Structures, turned into Python dictionaries. *)
9274 pr "static PyObject *\n";
9275 pr "put_%s (struct guestfs_%s *%s)\n" typ typ typ;
9277 pr " PyObject *dict;\n";
9279 pr " dict = PyDict_New ();\n";
9283 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9284 pr " PyString_FromString (%s->%s));\n"
9287 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9288 pr " PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
9291 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9292 pr " PyString_FromStringAndSize (%s->%s, 32));\n"
9294 | name, (FBytes|FUInt64) ->
9295 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9296 pr " PyLong_FromUnsignedLongLong (%s->%s));\n"
9299 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9300 pr " PyLong_FromLongLong (%s->%s));\n"
9303 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9304 pr " PyLong_FromUnsignedLong (%s->%s));\n"
9307 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9308 pr " PyLong_FromLong (%s->%s));\n"
9310 | name, FOptPercent ->
9311 pr " if (%s->%s >= 0)\n" typ name;
9312 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9313 pr " PyFloat_FromDouble ((double) %s->%s));\n"
9316 pr " Py_INCREF (Py_None);\n";
9317 pr " PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
9320 pr " PyDict_SetItemString (dict, \"%s\",\n" name;
9321 pr " PyString_FromStringAndSize (&dirent->%s, 1));\n" name
9323 pr " return dict;\n";
9329 (* Emit a put_TYPE_list function definition only if that function is used. *)
9332 | typ, (RStructListOnly | RStructAndList) ->
9333 (* generate the function for typ *)
9334 emit_put_list_function typ
9335 | typ, _ -> () (* empty *)
9336 ) (rstructs_used_by all_functions);
9338 (* Python wrapper functions. *)
9340 fun (name, style, _, _, _, _, _) ->
9341 pr "static PyObject *\n";
9342 pr "py_guestfs_%s (PyObject *self, PyObject *args)\n" name;
9345 pr " PyObject *py_g;\n";
9346 pr " guestfs_h *g;\n";
9347 pr " PyObject *py_r;\n";
9350 match fst style with
9351 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9352 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9353 | RConstString _ | RConstOptString _ ->
9354 pr " const char *r;\n"; "NULL"
9355 | RString _ -> pr " char *r;\n"; "NULL"
9356 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9357 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9358 | RStructList (_, typ) ->
9359 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9362 pr " size_t size;\n";
9367 | Pathname n | Device n | Dev_or_Path n | String n
9368 | FileIn n | FileOut n ->
9369 pr " const char *%s;\n" n
9370 | OptString n -> pr " const char *%s;\n" n
9372 pr " const char *%s;\n" n;
9373 pr " Py_ssize_t %s_size;\n" n
9374 | StringList n | DeviceList n ->
9375 pr " PyObject *py_%s;\n" n;
9376 pr " char **%s;\n" n
9377 | Bool n -> pr " int %s;\n" n
9378 | Int n -> pr " int %s;\n" n
9379 | Int64 n -> pr " long long %s;\n" n
9384 (* Convert the parameters. *)
9385 pr " if (!PyArg_ParseTuple (args, (char *) \"O";
9388 | Pathname _ | Device _ | Dev_or_Path _ | String _ | FileIn _ | FileOut _ -> pr "s"
9389 | OptString _ -> pr "z"
9390 | StringList _ | DeviceList _ -> pr "O"
9391 | Bool _ -> pr "i" (* XXX Python has booleans? *)
9393 | Int64 _ -> pr "L" (* XXX Whoever thought it was a good idea to
9394 * emulate C's int/long/long long in Python?
9396 | BufferIn _ -> pr "s#"
9398 pr ":guestfs_%s\",\n" name;
9402 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n -> pr ", &%s" n
9403 | OptString n -> pr ", &%s" n
9404 | StringList n | DeviceList n -> pr ", &py_%s" n
9405 | Bool n -> pr ", &%s" n
9406 | Int n -> pr ", &%s" n
9407 | Int64 n -> pr ", &%s" n
9408 | BufferIn n -> pr ", &%s, &%s_size" n n
9412 pr " return NULL;\n";
9414 pr " g = get_handle (py_g);\n";
9417 | Pathname _ | Device _ | Dev_or_Path _ | String _
9418 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9420 | StringList n | DeviceList n ->
9421 pr " %s = get_string_list (py_%s);\n" n n;
9422 pr " if (!%s) return NULL;\n" n
9427 pr " r = guestfs_%s " name;
9428 generate_c_call_args ~handle:"g" style;
9433 | Pathname _ | Device _ | Dev_or_Path _ | String _
9434 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9436 | StringList n | DeviceList n ->
9437 pr " free (%s);\n" n
9440 pr " if (r == %s) {\n" error_code;
9441 pr " PyErr_SetString (PyExc_RuntimeError, guestfs_last_error (g));\n";
9442 pr " return NULL;\n";
9446 (match fst style with
9448 pr " Py_INCREF (Py_None);\n";
9449 pr " py_r = Py_None;\n"
9451 | RBool _ -> pr " py_r = PyInt_FromLong ((long) r);\n"
9452 | RInt64 _ -> pr " py_r = PyLong_FromLongLong (r);\n"
9453 | RConstString _ -> pr " py_r = PyString_FromString (r);\n"
9454 | RConstOptString _ ->
9456 pr " py_r = PyString_FromString (r);\n";
9458 pr " Py_INCREF (Py_None);\n";
9459 pr " py_r = Py_None;\n";
9462 pr " py_r = PyString_FromString (r);\n";
9465 pr " py_r = put_string_list (r);\n";
9466 pr " free_strings (r);\n"
9467 | RStruct (_, typ) ->
9468 pr " py_r = put_%s (r);\n" typ;
9469 pr " guestfs_free_%s (r);\n" typ
9470 | RStructList (_, typ) ->
9471 pr " py_r = put_%s_list (r);\n" typ;
9472 pr " guestfs_free_%s_list (r);\n" typ
9474 pr " py_r = put_table (r);\n";
9475 pr " free_strings (r);\n"
9477 pr " py_r = PyString_FromStringAndSize (r, size);\n";
9481 pr " return py_r;\n";
9486 (* Table of functions. *)
9487 pr "static PyMethodDef methods[] = {\n";
9488 pr " { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
9489 pr " { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
9491 fun (name, _, _, _, _, _, _) ->
9492 pr " { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
9495 pr " { NULL, NULL, 0, NULL }\n";
9499 (* Init function. *)
9502 initlibguestfsmod (void)
9504 static int initialized = 0;
9506 if (initialized) return;
9507 Py_InitModule ((char *) \"libguestfsmod\", methods);
9512 (* Generate Python module. *)
9513 and generate_python_py () =
9514 generate_header HashStyle LGPLv2plus;
9517 u\"\"\"Python bindings for libguestfs
9520 g = guestfs.GuestFS ()
9521 g.add_drive (\"guest.img\")
9523 parts = g.list_partitions ()
9525 The guestfs module provides a Python binding to the libguestfs API
9526 for examining and modifying virtual machine disk images.
9528 Amongst the things this is good for: making batch configuration
9529 changes to guests, getting disk used/free statistics (see also:
9530 virt-df), migrating between virtualization systems (see also:
9531 virt-p2v), performing partial backups, performing partial guest
9532 clones, cloning guests and changing registry/UUID/hostname info, and
9535 Libguestfs uses Linux kernel and qemu code, and can access any type of
9536 guest filesystem that Linux and qemu can, including but not limited
9537 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
9538 schemes, qcow, qcow2, vmdk.
9540 Libguestfs provides ways to enumerate guest storage (eg. partitions,
9541 LVs, what filesystem is in each LV, etc.). It can also run commands
9542 in the context of the guest. Also you can access filesystems over
9545 Errors which happen while using the API are turned into Python
9546 RuntimeError exceptions.
9548 To create a guestfs handle you usually have to perform the following
9551 # Create the handle, call add_drive at least once, and possibly
9552 # several times if the guest has multiple block devices:
9553 g = guestfs.GuestFS ()
9554 g.add_drive (\"guest.img\")
9556 # Launch the qemu subprocess and wait for it to become ready:
9559 # Now you can issue commands, for example:
9564 import libguestfsmod
9567 \"\"\"Instances of this class are libguestfs API handles.\"\"\"
9569 def __init__ (self):
9570 \"\"\"Create a new libguestfs handle.\"\"\"
9571 self._o = libguestfsmod.create ()
9574 libguestfsmod.close (self._o)
9579 fun (name, style, _, flags, _, _, longdesc) ->
9581 generate_py_call_args ~handle:"self" (snd style);
9584 if not (List.mem NotInDocs flags) then (
9585 let doc = replace_str longdesc "C<guestfs_" "C<g." in
9587 match fst style with
9588 | RErr | RInt _ | RInt64 _ | RBool _
9589 | RConstOptString _ | RConstString _
9590 | RString _ | RBufferOut _ -> doc
9592 doc ^ "\n\nThis function returns a list of strings."
9593 | RStruct (_, typ) ->
9594 doc ^ sprintf "\n\nThis function returns a dictionary, with keys matching the various fields in the guestfs_%s structure." typ
9595 | RStructList (_, typ) ->
9596 doc ^ sprintf "\n\nThis function returns a list of %ss. Each %s is represented as a dictionary." typ typ
9598 doc ^ "\n\nThis function returns a dictionary." in
9600 if List.mem ProtocolLimitWarning flags then
9601 doc ^ "\n\n" ^ protocol_limit_warning
9604 if List.mem DangerWillRobinson flags then
9605 doc ^ "\n\n" ^ danger_will_robinson
9608 match deprecation_notice flags with
9610 | Some txt -> doc ^ "\n\n" ^ txt in
9611 let doc = pod2text ~width:60 name doc in
9612 let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
9613 let doc = String.concat "\n " doc in
9614 pr " u\"\"\"%s\"\"\"\n" doc;
9616 pr " return libguestfsmod.%s " name;
9617 generate_py_call_args ~handle:"self._o" (snd style);
9622 (* Generate Python call arguments, eg "(handle, foo, bar)" *)
9623 and generate_py_call_args ~handle args =
9625 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
9628 (* Useful if you need the longdesc POD text as plain text. Returns a
9631 * Because this is very slow (the slowest part of autogeneration),
9632 * we memoize the results.
9634 and pod2text ~width name longdesc =
9635 let key = width, name, longdesc in
9636 try Hashtbl.find pod2text_memo key
9638 let filename, chan = Filename.open_temp_file "gen" ".tmp" in
9639 fprintf chan "=head1 %s\n\n%s\n" name longdesc;
9641 let cmd = sprintf "pod2text -w %d %s" width (Filename.quote filename) in
9642 let chan = open_process_in cmd in
9643 let lines = ref [] in
9645 let line = input_line chan in
9646 if i = 1 then (* discard the first line of output *)
9649 let line = triml line in
9650 lines := line :: !lines;
9653 let lines = try loop 1 with End_of_file -> List.rev !lines in
9655 (match close_process_in chan with
9658 failwithf "pod2text: process exited with non-zero status (%d)" i
9659 | WSIGNALED i | WSTOPPED i ->
9660 failwithf "pod2text: process signalled or stopped by signal %d" i
9662 Hashtbl.add pod2text_memo key lines;
9663 pod2text_memo_updated ();
9666 (* Generate ruby bindings. *)
9667 and generate_ruby_c () =
9668 generate_header CStyle LGPLv2plus;
9676 #include \"guestfs.h\"
9678 #include \"extconf.h\"
9680 /* For Ruby < 1.9 */
9682 #define RARRAY_LEN(r) (RARRAY((r))->len)
9685 static VALUE m_guestfs; /* guestfs module */
9686 static VALUE c_guestfs; /* guestfs_h handle */
9687 static VALUE e_Error; /* used for all errors */
9689 static void ruby_guestfs_free (void *p)
9692 guestfs_close ((guestfs_h *) p);
9695 static VALUE ruby_guestfs_create (VALUE m)
9699 g = guestfs_create ();
9701 rb_raise (e_Error, \"failed to create guestfs handle\");
9703 /* Don't print error messages to stderr by default. */
9704 guestfs_set_error_handler (g, NULL, NULL);
9706 /* Wrap it, and make sure the close function is called when the
9709 return Data_Wrap_Struct (c_guestfs, NULL, ruby_guestfs_free, g);
9712 static VALUE ruby_guestfs_close (VALUE gv)
9715 Data_Get_Struct (gv, guestfs_h, g);
9717 ruby_guestfs_free (g);
9718 DATA_PTR (gv) = NULL;
9726 fun (name, style, _, _, _, _, _) ->
9727 pr "static VALUE ruby_guestfs_%s (VALUE gv" name;
9728 List.iter (fun arg -> pr ", VALUE %sv" (name_of_argt arg)) (snd style);
9731 pr " guestfs_h *g;\n";
9732 pr " Data_Get_Struct (gv, guestfs_h, g);\n";
9734 pr " rb_raise (rb_eArgError, \"%%s: used handle after closing it\", \"%s\");\n"
9740 | Pathname n | Device n | Dev_or_Path n | String n | FileIn n | FileOut n ->
9741 pr " Check_Type (%sv, T_STRING);\n" n;
9742 pr " const char *%s = StringValueCStr (%sv);\n" n n;
9744 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9745 pr " \"%s\", \"%s\");\n" n name
9747 pr " Check_Type (%sv, T_STRING);\n" n;
9748 pr " const char *%s = RSTRING (%sv)->ptr;\n" n n;
9750 pr " rb_raise (rb_eTypeError, \"expected string for parameter %%s of %%s\",\n";
9751 pr " \"%s\", \"%s\");\n" n name;
9752 pr " size_t %s_size = RSTRING (%sv)->len;\n" n n
9754 pr " const char *%s = !NIL_P (%sv) ? StringValueCStr (%sv) : NULL;\n" n n n
9755 | StringList n | DeviceList n ->
9756 pr " char **%s;\n" n;
9757 pr " Check_Type (%sv, T_ARRAY);\n" n;
9759 pr " int i, len;\n";
9760 pr " len = RARRAY_LEN (%sv);\n" n;
9761 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (len+1));\n"
9763 pr " for (i = 0; i < len; ++i) {\n";
9764 pr " VALUE v = rb_ary_entry (%sv, i);\n" n;
9765 pr " %s[i] = StringValueCStr (v);\n" n;
9767 pr " %s[len] = NULL;\n" n;
9770 pr " int %s = RTEST (%sv);\n" n n
9772 pr " int %s = NUM2INT (%sv);\n" n n
9774 pr " long long %s = NUM2LL (%sv);\n" n n
9779 match fst style with
9780 | RErr | RInt _ | RBool _ -> pr " int r;\n"; "-1"
9781 | RInt64 _ -> pr " int64_t r;\n"; "-1"
9782 | RConstString _ | RConstOptString _ ->
9783 pr " const char *r;\n"; "NULL"
9784 | RString _ -> pr " char *r;\n"; "NULL"
9785 | RStringList _ | RHashtable _ -> pr " char **r;\n"; "NULL"
9786 | RStruct (_, typ) -> pr " struct guestfs_%s *r;\n" typ; "NULL"
9787 | RStructList (_, typ) ->
9788 pr " struct guestfs_%s_list *r;\n" typ; "NULL"
9791 pr " size_t size;\n";
9795 pr " r = guestfs_%s " name;
9796 generate_c_call_args ~handle:"g" style;
9801 | Pathname _ | Device _ | Dev_or_Path _ | String _
9802 | FileIn _ | FileOut _ | OptString _ | Bool _ | Int _ | Int64 _
9804 | StringList n | DeviceList n ->
9805 pr " free (%s);\n" n
9808 pr " if (r == %s)\n" error_code;
9809 pr " rb_raise (e_Error, \"%%s\", guestfs_last_error (g));\n";
9812 (match fst style with
9814 pr " return Qnil;\n"
9815 | RInt _ | RBool _ ->
9816 pr " return INT2NUM (r);\n"
9818 pr " return ULL2NUM (r);\n"
9820 pr " return rb_str_new2 (r);\n";
9821 | RConstOptString _ ->
9823 pr " return rb_str_new2 (r);\n";
9825 pr " return Qnil;\n";
9827 pr " VALUE rv = rb_str_new2 (r);\n";
9831 pr " int i, len = 0;\n";
9832 pr " for (i = 0; r[i] != NULL; ++i) len++;\n";
9833 pr " VALUE rv = rb_ary_new2 (len);\n";
9834 pr " for (i = 0; r[i] != NULL; ++i) {\n";
9835 pr " rb_ary_push (rv, rb_str_new2 (r[i]));\n";
9836 pr " free (r[i]);\n";
9840 | RStruct (_, typ) ->
9841 let cols = cols_of_struct typ in
9842 generate_ruby_struct_code typ cols
9843 | RStructList (_, typ) ->
9844 let cols = cols_of_struct typ in
9845 generate_ruby_struct_list_code typ cols
9847 pr " VALUE rv = rb_hash_new ();\n";
9849 pr " for (i = 0; r[i] != NULL; i+=2) {\n";
9850 pr " rb_hash_aset (rv, rb_str_new2 (r[i]), rb_str_new2 (r[i+1]));\n";
9851 pr " free (r[i]);\n";
9852 pr " free (r[i+1]);\n";
9857 pr " VALUE rv = rb_str_new (r, size);\n";
9867 /* Initialize the module. */
9868 void Init__guestfs ()
9870 m_guestfs = rb_define_module (\"Guestfs\");
9871 c_guestfs = rb_define_class_under (m_guestfs, \"Guestfs\", rb_cObject);
9872 e_Error = rb_define_class_under (m_guestfs, \"Error\", rb_eStandardError);
9874 rb_define_module_function (m_guestfs, \"create\", ruby_guestfs_create, 0);
9875 rb_define_method (c_guestfs, \"close\", ruby_guestfs_close, 0);
9878 (* Define the rest of the methods. *)
9880 fun (name, style, _, _, _, _, _) ->
9881 pr " rb_define_method (c_guestfs, \"%s\",\n" name;
9882 pr " ruby_guestfs_%s, %d);\n" name (List.length (snd style))
9887 (* Ruby code to return a struct. *)
9888 and generate_ruby_struct_code typ cols =
9889 pr " VALUE rv = rb_hash_new ();\n";
9893 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new2 (r->%s));\n" name name
9895 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, r->%s_len));\n" name name name
9897 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_str_new (r->%s, 32));\n" name name
9898 | name, (FBytes|FUInt64) ->
9899 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9901 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), LL2NUM (r->%s));\n" name name
9903 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), UINT2NUM (r->%s));\n" name name
9905 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), INT2NUM (r->%s));\n" name name
9906 | name, FOptPercent ->
9907 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), rb_dbl2big (r->%s));\n" name name
9908 | name, FChar -> (* XXX wrong? *)
9909 pr " rb_hash_aset (rv, rb_str_new2 (\"%s\"), ULL2NUM (r->%s));\n" name name
9911 pr " guestfs_free_%s (r);\n" typ;
9914 (* Ruby code to return a struct list. *)
9915 and generate_ruby_struct_list_code typ cols =
9916 pr " VALUE rv = rb_ary_new2 (r->len);\n";
9918 pr " for (i = 0; i < r->len; ++i) {\n";
9919 pr " VALUE hv = rb_hash_new ();\n";
9923 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new2 (r->val[i].%s));\n" name name
9925 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
9927 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_str_new (r->val[i].%s, 32));\n" name name
9928 | name, (FBytes|FUInt64) ->
9929 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9931 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), LL2NUM (r->val[i].%s));\n" name name
9933 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), UINT2NUM (r->val[i].%s));\n" name name
9935 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), INT2NUM (r->val[i].%s));\n" name name
9936 | name, FOptPercent ->
9937 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), rb_dbl2big (r->val[i].%s));\n" name name
9938 | name, FChar -> (* XXX wrong? *)
9939 pr " rb_hash_aset (hv, rb_str_new2 (\"%s\"), ULL2NUM (r->val[i].%s));\n" name name
9941 pr " rb_ary_push (rv, hv);\n";
9943 pr " guestfs_free_%s_list (r);\n" typ;
9946 (* Generate Java bindings GuestFS.java file. *)
9947 and generate_java_java () =
9948 generate_header CStyle LGPLv2plus;
9951 package com.redhat.et.libguestfs;
9953 import java.util.HashMap;
9954 import com.redhat.et.libguestfs.LibGuestFSException;
9955 import com.redhat.et.libguestfs.PV;
9956 import com.redhat.et.libguestfs.VG;
9957 import com.redhat.et.libguestfs.LV;
9958 import com.redhat.et.libguestfs.Stat;
9959 import com.redhat.et.libguestfs.StatVFS;
9960 import com.redhat.et.libguestfs.IntBool;
9961 import com.redhat.et.libguestfs.Dirent;
9964 * The GuestFS object is a libguestfs handle.
9968 public class GuestFS {
9969 // Load the native code.
9971 System.loadLibrary (\"guestfs_jni\");
9975 * The native guestfs_h pointer.
9980 * Create a libguestfs handle.
9982 * @throws LibGuestFSException
9984 public GuestFS () throws LibGuestFSException
9988 private native long _create () throws LibGuestFSException;
9991 * Close a libguestfs handle.
9993 * You can also leave handles to be collected by the garbage
9994 * collector, but this method ensures that the resources used
9995 * by the handle are freed up immediately. If you call any
9996 * other methods after closing the handle, you will get an
9999 * @throws LibGuestFSException
10001 public void close () throws LibGuestFSException
10007 private native void _close (long g) throws LibGuestFSException;
10009 public void finalize () throws LibGuestFSException
10017 fun (name, style, _, flags, _, shortdesc, longdesc) ->
10018 if not (List.mem NotInDocs flags); then (
10019 let doc = replace_str longdesc "C<guestfs_" "C<g." in
10021 if List.mem ProtocolLimitWarning flags then
10022 doc ^ "\n\n" ^ protocol_limit_warning
10025 if List.mem DangerWillRobinson flags then
10026 doc ^ "\n\n" ^ danger_will_robinson
10029 match deprecation_notice flags with
10031 | Some txt -> doc ^ "\n\n" ^ txt in
10032 let doc = pod2text ~width:60 name doc in
10033 let doc = List.map ( (* RHBZ#501883 *)
10036 | nonempty -> nonempty
10038 let doc = String.concat "\n * " doc in
10041 pr " * %s\n" shortdesc;
10044 pr " * @throws LibGuestFSException\n";
10048 generate_java_prototype ~public:true ~semicolon:false name style;
10051 pr " if (g == 0)\n";
10052 pr " throw new LibGuestFSException (\"%s: handle is closed\");\n"
10055 if fst style <> RErr then pr "return ";
10057 generate_java_call_args ~handle:"g" (snd style);
10061 generate_java_prototype ~privat:true ~native:true name style;
10068 (* Generate Java call arguments, eg "(handle, foo, bar)" *)
10069 and generate_java_call_args ~handle args =
10071 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
10074 and generate_java_prototype ?(public=false) ?(privat=false) ?(native=false)
10075 ?(semicolon=true) name style =
10076 if privat then pr "private ";
10077 if public then pr "public ";
10078 if native then pr "native ";
10081 (match fst style with
10082 | RErr -> pr "void ";
10083 | RInt _ -> pr "int ";
10084 | RInt64 _ -> pr "long ";
10085 | RBool _ -> pr "boolean ";
10086 | RConstString _ | RConstOptString _ | RString _
10087 | RBufferOut _ -> pr "String ";
10088 | RStringList _ -> pr "String[] ";
10089 | RStruct (_, typ) ->
10090 let name = java_name_of_struct typ in
10092 | RStructList (_, typ) ->
10093 let name = java_name_of_struct typ in
10095 | RHashtable _ -> pr "HashMap<String,String> ";
10098 if native then pr "_%s " name else pr "%s " name;
10100 let needs_comma = ref false in
10103 needs_comma := true
10109 if !needs_comma then pr ", ";
10110 needs_comma := true;
10114 | Device n | Dev_or_Path n
10122 | StringList n | DeviceList n ->
10133 pr " throws LibGuestFSException";
10134 if semicolon then pr ";"
10136 and generate_java_struct jtyp cols () =
10137 generate_header CStyle LGPLv2plus;
10140 package com.redhat.et.libguestfs;
10143 * Libguestfs %s structure.
10155 | name, FBuffer -> pr " public String %s;\n" name
10156 | name, (FBytes|FUInt64|FInt64) -> pr " public long %s;\n" name
10157 | name, (FUInt32|FInt32) -> pr " public int %s;\n" name
10158 | name, FChar -> pr " public char %s;\n" name
10159 | name, FOptPercent ->
10160 pr " /* The next field is [0..100] or -1 meaning 'not present': */\n";
10161 pr " public float %s;\n" name
10166 and generate_java_c () =
10167 generate_header CStyle LGPLv2plus;
10171 #include <stdlib.h>
10172 #include <string.h>
10174 #include \"com_redhat_et_libguestfs_GuestFS.h\"
10175 #include \"guestfs.h\"
10177 /* Note that this function returns. The exception is not thrown
10178 * until after the wrapper function returns.
10181 throw_exception (JNIEnv *env, const char *msg)
10184 cl = (*env)->FindClass (env,
10185 \"com/redhat/et/libguestfs/LibGuestFSException\");
10186 (*env)->ThrowNew (env, cl, msg);
10189 JNIEXPORT jlong JNICALL
10190 Java_com_redhat_et_libguestfs_GuestFS__1create
10191 (JNIEnv *env, jobject obj)
10195 g = guestfs_create ();
10197 throw_exception (env, \"GuestFS.create: failed to allocate handle\");
10200 guestfs_set_error_handler (g, NULL, NULL);
10201 return (jlong) (long) g;
10204 JNIEXPORT void JNICALL
10205 Java_com_redhat_et_libguestfs_GuestFS__1close
10206 (JNIEnv *env, jobject obj, jlong jg)
10208 guestfs_h *g = (guestfs_h *) (long) jg;
10215 fun (name, style, _, _, _, _, _) ->
10217 (match fst style with
10218 | RErr -> pr "void ";
10219 | RInt _ -> pr "jint ";
10220 | RInt64 _ -> pr "jlong ";
10221 | RBool _ -> pr "jboolean ";
10222 | RConstString _ | RConstOptString _ | RString _
10223 | RBufferOut _ -> pr "jstring ";
10224 | RStruct _ | RHashtable _ ->
10226 | RStringList _ | RStructList _ ->
10227 pr "jobjectArray ";
10230 pr "Java_com_redhat_et_libguestfs_GuestFS_";
10231 pr "%s" (replace_str ("_" ^ name) "_" "_1");
10233 pr " (JNIEnv *env, jobject obj, jlong jg";
10237 | Device n | Dev_or_Path n
10242 pr ", jstring j%s" n
10244 pr ", jbyteArray j%s" n
10245 | StringList n | DeviceList n ->
10246 pr ", jobjectArray j%s" n
10248 pr ", jboolean j%s" n
10256 pr " guestfs_h *g = (guestfs_h *) (long) jg;\n";
10257 let error_code, no_ret =
10258 match fst style with
10259 | RErr -> pr " int r;\n"; "-1", ""
10261 | RInt _ -> pr " int r;\n"; "-1", "0"
10262 | RInt64 _ -> pr " int64_t r;\n"; "-1", "0"
10263 | RConstString _ -> pr " const char *r;\n"; "NULL", "NULL"
10264 | RConstOptString _ -> pr " const char *r;\n"; "NULL", "NULL"
10266 pr " jstring jr;\n";
10267 pr " char *r;\n"; "NULL", "NULL"
10269 pr " jobjectArray jr;\n";
10270 pr " int r_len;\n";
10271 pr " jclass cl;\n";
10272 pr " jstring jstr;\n";
10273 pr " char **r;\n"; "NULL", "NULL"
10274 | RStruct (_, typ) ->
10275 pr " jobject jr;\n";
10276 pr " jclass cl;\n";
10277 pr " jfieldID fl;\n";
10278 pr " struct guestfs_%s *r;\n" typ; "NULL", "NULL"
10279 | RStructList (_, typ) ->
10280 pr " jobjectArray jr;\n";
10281 pr " jclass cl;\n";
10282 pr " jfieldID fl;\n";
10283 pr " jobject jfl;\n";
10284 pr " struct guestfs_%s_list *r;\n" typ; "NULL", "NULL"
10285 | RHashtable _ -> pr " char **r;\n"; "NULL", "NULL"
10287 pr " jstring jr;\n";
10289 pr " size_t size;\n";
10294 | Device n | Dev_or_Path n
10299 pr " const char *%s;\n" n
10301 pr " jbyte *%s;\n" n;
10302 pr " size_t %s_size;\n" n
10303 | StringList n | DeviceList n ->
10304 pr " int %s_len;\n" n;
10305 pr " const char **%s;\n" n
10310 pr " int64_t %s;\n" n
10314 (match fst style with
10315 | RStringList _ | RStructList _ -> true
10316 | RErr | RBool _ | RInt _ | RInt64 _ | RConstString _
10317 | RConstOptString _
10318 | RString _ | RBufferOut _ | RStruct _ | RHashtable _ -> false) ||
10319 List.exists (function
10320 | StringList _ -> true
10321 | DeviceList _ -> true
10322 | _ -> false) (snd style) in
10328 (* Get the parameters. *)
10332 | Device n | Dev_or_Path n
10336 pr " %s = (*env)->GetStringUTFChars (env, j%s, NULL);\n" n n
10338 (* This is completely undocumented, but Java null becomes
10339 * a NULL parameter.
10341 pr " %s = j%s ? (*env)->GetStringUTFChars (env, j%s, NULL) : NULL;\n" n n n
10343 pr " %s = (*env)->GetByteArrayElements (env, j%s, NULL);\n" n n;
10344 pr " %s_size = (*env)->GetArrayLength (env, j%s);\n" n n
10345 | StringList n | DeviceList n ->
10346 pr " %s_len = (*env)->GetArrayLength (env, j%s);\n" n n;
10347 pr " %s = guestfs_safe_malloc (g, sizeof (char *) * (%s_len+1));\n" n n;
10348 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10349 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10351 pr " %s[i] = (*env)->GetStringUTFChars (env, o, NULL);\n" n;
10353 pr " %s[%s_len] = NULL;\n" n n;
10357 pr " %s = j%s;\n" n n
10360 (* Make the call. *)
10361 pr " r = guestfs_%s " name;
10362 generate_c_call_args ~handle:"g" style;
10365 (* Release the parameters. *)
10369 | Device n | Dev_or_Path n
10373 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10375 pr " if (j%s)\n" n;
10376 pr " (*env)->ReleaseStringUTFChars (env, j%s, %s);\n" n n
10378 pr " (*env)->ReleaseByteArrayElements (env, j%s, %s, 0);\n" n n
10379 | StringList n | DeviceList n ->
10380 pr " for (i = 0; i < %s_len; ++i) {\n" n;
10381 pr " jobject o = (*env)->GetObjectArrayElement (env, j%s, i);\n"
10383 pr " (*env)->ReleaseStringUTFChars (env, o, %s[i]);\n" n;
10385 pr " free (%s);\n" n
10391 (* Check for errors. *)
10392 pr " if (r == %s) {\n" error_code;
10393 pr " throw_exception (env, guestfs_last_error (g));\n";
10394 pr " return %s;\n" no_ret;
10397 (* Return value. *)
10398 (match fst style with
10400 | RInt _ -> pr " return (jint) r;\n"
10401 | RBool _ -> pr " return (jboolean) r;\n"
10402 | RInt64 _ -> pr " return (jlong) r;\n"
10403 | RConstString _ -> pr " return (*env)->NewStringUTF (env, r);\n"
10404 | RConstOptString _ ->
10405 pr " return (*env)->NewStringUTF (env, r); /* XXX r NULL? */\n"
10407 pr " jr = (*env)->NewStringUTF (env, r);\n";
10411 pr " for (r_len = 0; r[r_len] != NULL; ++r_len) ;\n";
10412 pr " cl = (*env)->FindClass (env, \"java/lang/String\");\n";
10413 pr " jstr = (*env)->NewStringUTF (env, \"\");\n";
10414 pr " jr = (*env)->NewObjectArray (env, r_len, cl, jstr);\n";
10415 pr " for (i = 0; i < r_len; ++i) {\n";
10416 pr " jstr = (*env)->NewStringUTF (env, r[i]);\n";
10417 pr " (*env)->SetObjectArrayElement (env, jr, i, jstr);\n";
10418 pr " free (r[i]);\n";
10422 | RStruct (_, typ) ->
10423 let jtyp = java_name_of_struct typ in
10424 let cols = cols_of_struct typ in
10425 generate_java_struct_return typ jtyp cols
10426 | RStructList (_, typ) ->
10427 let jtyp = java_name_of_struct typ in
10428 let cols = cols_of_struct typ in
10429 generate_java_struct_list_return typ jtyp cols
10432 pr " throw_exception (env, \"%s: internal error: please let us know how to make a Java HashMap from JNI bindings!\");\n" name;
10433 pr " return NULL;\n"
10435 pr " jr = (*env)->NewStringUTF (env, r); /* XXX size */\n";
10444 and generate_java_struct_return typ jtyp cols =
10445 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10446 pr " jr = (*env)->AllocObject (env, cl);\n";
10450 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10451 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, r->%s));\n" name;
10454 pr " char s[33];\n";
10455 pr " memcpy (s, r->%s, 32);\n" name;
10456 pr " s[32] = 0;\n";
10457 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10458 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10462 pr " int len = r->%s_len;\n" name;
10463 pr " char s[len+1];\n";
10464 pr " memcpy (s, r->%s, len);\n" name;
10465 pr " s[len] = 0;\n";
10466 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10467 pr " (*env)->SetObjectField (env, jr, fl, (*env)->NewStringUTF (env, s));\n";
10469 | name, (FBytes|FUInt64|FInt64) ->
10470 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10471 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10472 | name, (FUInt32|FInt32) ->
10473 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10474 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10475 | name, FOptPercent ->
10476 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10477 pr " (*env)->SetFloatField (env, jr, fl, r->%s);\n" name;
10479 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10480 pr " (*env)->SetLongField (env, jr, fl, r->%s);\n" name;
10485 and generate_java_struct_list_return typ jtyp cols =
10486 pr " cl = (*env)->FindClass (env, \"com/redhat/et/libguestfs/%s\");\n" jtyp;
10487 pr " jr = (*env)->NewObjectArray (env, r->len, cl, NULL);\n";
10488 pr " for (i = 0; i < r->len; ++i) {\n";
10489 pr " jfl = (*env)->AllocObject (env, cl);\n";
10493 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10494 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, r->val[i].%s));\n" name;
10497 pr " char s[33];\n";
10498 pr " memcpy (s, r->val[i].%s, 32);\n" name;
10499 pr " s[32] = 0;\n";
10500 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10501 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10505 pr " int len = r->val[i].%s_len;\n" name;
10506 pr " char s[len+1];\n";
10507 pr " memcpy (s, r->val[i].%s, len);\n" name;
10508 pr " s[len] = 0;\n";
10509 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"Ljava/lang/String;\");\n" name;
10510 pr " (*env)->SetObjectField (env, jfl, fl, (*env)->NewStringUTF (env, s));\n";
10512 | name, (FBytes|FUInt64|FInt64) ->
10513 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"J\");\n" name;
10514 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10515 | name, (FUInt32|FInt32) ->
10516 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"I\");\n" name;
10517 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10518 | name, FOptPercent ->
10519 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"F\");\n" name;
10520 pr " (*env)->SetFloatField (env, jfl, fl, r->val[i].%s);\n" name;
10522 pr " fl = (*env)->GetFieldID (env, cl, \"%s\", \"C\");\n" name;
10523 pr " (*env)->SetLongField (env, jfl, fl, r->val[i].%s);\n" name;
10525 pr " (*env)->SetObjectArrayElement (env, jfl, i, jfl);\n";
10527 pr " guestfs_free_%s_list (r);\n" typ;
10530 and generate_java_makefile_inc () =
10531 generate_header HashStyle GPLv2plus;
10533 pr "java_built_sources = \\\n";
10536 pr "\tcom/redhat/et/libguestfs/%s.java \\\n" jtyp;
10538 pr "\tcom/redhat/et/libguestfs/GuestFS.java\n"
10540 and generate_haskell_hs () =
10541 generate_header HaskellStyle LGPLv2plus;
10543 (* XXX We only know how to generate partial FFI for Haskell
10544 * at the moment. Please help out!
10546 let can_generate style =
10550 | RInt64 _, _ -> true
10552 | RConstString _, _
10553 | RConstOptString _, _
10559 | RBufferOut _, _ -> false in
10562 {-# INCLUDE <guestfs.h> #-}
10563 {-# LANGUAGE ForeignFunctionInterface #-}
10568 (* List out the names of the actions we want to export. *)
10570 fun (name, style, _, _, _, _, _) ->
10571 if can_generate style then pr ",\n %s" name
10577 -- Unfortunately some symbols duplicate ones already present
10578 -- in Prelude. We don't know which, so we hard-code a list
10580 import Prelude hiding (truncate)
10584 import Foreign.C.Types
10586 import Control.Exception
10587 import Data.Typeable
10589 data GuestfsS = GuestfsS -- represents the opaque C struct
10590 type GuestfsP = Ptr GuestfsS -- guestfs_h *
10591 type GuestfsH = ForeignPtr GuestfsS -- guestfs_h * with attached finalizer
10593 -- XXX define properly later XXX
10597 data IntBool = IntBool
10599 data StatVFS = StatVFS
10600 data Hashtable = Hashtable
10602 foreign import ccall unsafe \"guestfs_create\" c_create
10604 foreign import ccall unsafe \"&guestfs_close\" c_close
10605 :: FunPtr (GuestfsP -> IO ())
10606 foreign import ccall unsafe \"guestfs_set_error_handler\" c_set_error_handler
10607 :: GuestfsP -> Ptr CInt -> Ptr CInt -> IO ()
10609 create :: IO GuestfsH
10612 c_set_error_handler p nullPtr nullPtr
10613 h <- newForeignPtr c_close p
10616 foreign import ccall unsafe \"guestfs_last_error\" c_last_error
10617 :: GuestfsP -> IO CString
10619 -- last_error :: GuestfsH -> IO (Maybe String)
10620 -- last_error h = do
10621 -- str <- withForeignPtr h (\\p -> c_last_error p)
10622 -- maybePeek peekCString str
10624 last_error :: GuestfsH -> IO (String)
10626 str <- withForeignPtr h (\\p -> c_last_error p)
10627 if (str == nullPtr)
10628 then return \"no error\"
10629 else peekCString str
10633 (* Generate wrappers for each foreign function. *)
10635 fun (name, style, _, _, _, _, _) ->
10636 if can_generate style then (
10637 pr "foreign import ccall unsafe \"guestfs_%s\" c_%s\n" name name;
10639 generate_haskell_prototype ~handle:"GuestfsP" style;
10643 generate_haskell_prototype ~handle:"GuestfsH" ~hs:true style;
10645 pr "%s %s = do\n" name
10646 (String.concat " " ("h" :: List.map name_of_argt (snd style)));
10648 (* Convert pointer arguments using with* functions. *)
10653 | Pathname n | Device n | Dev_or_Path n | String n ->
10654 pr "withCString %s $ \\%s -> " n n
10656 pr "withCStringLen %s $ \\(%s, %s_size) -> " n n n
10657 | OptString n -> pr "maybeWith withCString %s $ \\%s -> " n n
10658 | StringList n | DeviceList n -> pr "withMany withCString %s $ \\%s -> withArray0 nullPtr %s $ \\%s -> " n n n n
10659 | Bool _ | Int _ | Int64 _ -> ()
10661 (* Convert integer arguments. *)
10665 | Bool n -> sprintf "(fromBool %s)" n
10666 | Int n -> sprintf "(fromIntegral %s)" n
10667 | Int64 n -> sprintf "(fromIntegral %s)" n
10668 | FileIn n | FileOut n
10669 | Pathname n | Device n | Dev_or_Path n | String n | OptString n | StringList n | DeviceList n -> n
10670 | BufferIn n -> sprintf "%s (fromIntegral %s_size)" n n
10672 pr "withForeignPtr h (\\p -> c_%s %s)\n" name
10673 (String.concat " " ("p" :: args));
10674 (match fst style with
10675 | RErr | RInt _ | RInt64 _ | RBool _ ->
10676 pr " if (r == -1)\n";
10678 pr " err <- last_error h\n";
10680 | RConstString _ | RConstOptString _ | RString _
10681 | RStringList _ | RStruct _
10682 | RStructList _ | RHashtable _ | RBufferOut _ ->
10683 pr " if (r == nullPtr)\n";
10685 pr " err <- last_error h\n";
10688 (match fst style with
10690 pr " else return ()\n"
10692 pr " else return (fromIntegral r)\n"
10694 pr " else return (fromIntegral r)\n"
10696 pr " else return (toBool r)\n"
10698 | RConstOptString _
10705 pr " else return ()\n" (* XXXXXXXXXXXXXXXXXXXX *)
10711 and generate_haskell_prototype ~handle ?(hs = false) style =
10712 pr "%s -> " handle;
10713 let string = if hs then "String" else "CString" in
10714 let int = if hs then "Int" else "CInt" in
10715 let bool = if hs then "Bool" else "CInt" in
10716 let int64 = if hs then "Integer" else "Int64" in
10720 | Pathname _ | Device _ | Dev_or_Path _ | String _ -> pr "%s" string
10722 if hs then pr "String"
10723 else pr "CString -> CInt"
10724 | OptString _ -> if hs then pr "Maybe String" else pr "CString"
10725 | StringList _ | DeviceList _ -> if hs then pr "[String]" else pr "Ptr CString"
10726 | Bool _ -> pr "%s" bool
10727 | Int _ -> pr "%s" int
10728 | Int64 _ -> pr "%s" int
10729 | FileIn _ -> pr "%s" string
10730 | FileOut _ -> pr "%s" string
10735 (match fst style with
10736 | RErr -> if not hs then pr "CInt"
10737 | RInt _ -> pr "%s" int
10738 | RInt64 _ -> pr "%s" int64
10739 | RBool _ -> pr "%s" bool
10740 | RConstString _ -> pr "%s" string
10741 | RConstOptString _ -> pr "Maybe %s" string
10742 | RString _ -> pr "%s" string
10743 | RStringList _ -> pr "[%s]" string
10744 | RStruct (_, typ) ->
10745 let name = java_name_of_struct typ in
10747 | RStructList (_, typ) ->
10748 let name = java_name_of_struct typ in
10750 | RHashtable _ -> pr "Hashtable"
10751 | RBufferOut _ -> pr "%s" string
10755 and generate_csharp () =
10756 generate_header CPlusPlusStyle LGPLv2plus;
10758 (* XXX Make this configurable by the C# assembly users. *)
10759 let library = "libguestfs.so.0" in
10762 // These C# bindings are highly experimental at present.
10764 // Firstly they only work on Linux (ie. Mono). In order to get them
10765 // to work on Windows (ie. .Net) you would need to port the library
10766 // itself to Windows first.
10768 // The second issue is that some calls are known to be incorrect and
10769 // can cause Mono to segfault. Particularly: calls which pass or
10770 // return string[], or return any structure value. This is because
10771 // we haven't worked out the correct way to do this from C#.
10773 // The third issue is that when compiling you get a lot of warnings.
10774 // We are not sure whether the warnings are important or not.
10776 // Fourthly we do not routinely build or test these bindings as part
10777 // of the make && make check cycle, which means that regressions might
10780 // Suggestions and patches are welcome.
10784 // gmcs Libguestfs.cs
10785 // mono Libguestfs.exe
10787 // (You'll probably want to add a Test class / static main function
10788 // otherwise this won't do anything useful).
10792 using System.Runtime.InteropServices;
10793 using System.Runtime.Serialization;
10794 using System.Collections;
10798 class Error : System.ApplicationException
10800 public Error (string message) : base (message) {}
10801 protected Error (SerializationInfo info, StreamingContext context) {}
10808 [DllImport (\"%s\")]
10809 static extern IntPtr guestfs_create ();
10813 _handle = guestfs_create ();
10814 if (_handle == IntPtr.Zero)
10815 throw new Error (\"could not create guestfs handle\");
10818 [DllImport (\"%s\")]
10819 static extern void guestfs_close (IntPtr h);
10823 guestfs_close (_handle);
10826 [DllImport (\"%s\")]
10827 static extern string guestfs_last_error (IntPtr h);
10829 " library library library;
10831 (* Generate C# structure bindings. We prefix struct names with
10832 * underscore because C# cannot have conflicting struct names and
10833 * method names (eg. "class stat" and "stat").
10837 pr " [StructLayout (LayoutKind.Sequential)]\n";
10838 pr " public class _%s {\n" typ;
10841 | name, FChar -> pr " char %s;\n" name
10842 | name, FString -> pr " string %s;\n" name
10844 pr " uint %s_len;\n" name;
10845 pr " string %s;\n" name
10847 pr " [MarshalAs (UnmanagedType.ByValTStr, SizeConst=16)]\n";
10848 pr " string %s;\n" name
10849 | name, FUInt32 -> pr " uint %s;\n" name
10850 | name, FInt32 -> pr " int %s;\n" name
10851 | name, (FUInt64|FBytes) -> pr " ulong %s;\n" name
10852 | name, FInt64 -> pr " long %s;\n" name
10853 | name, FOptPercent -> pr " float %s; /* [0..100] or -1 */\n" name
10859 (* Generate C# function bindings. *)
10861 fun (name, style, _, _, _, shortdesc, _) ->
10862 let rec csharp_return_type () =
10863 match fst style with
10865 | RBool n -> "bool"
10867 | RInt64 n -> "long"
10869 | RConstOptString n
10871 | RBufferOut n -> "string"
10872 | RStruct (_,n) -> "_" ^ n
10873 | RHashtable n -> "Hashtable"
10874 | RStringList n -> "string[]"
10875 | RStructList (_,n) -> sprintf "_%s[]" n
10877 and c_return_type () =
10878 match fst style with
10882 | RInt64 _ -> "long"
10884 | RConstOptString _
10886 | RBufferOut _ -> "string"
10887 | RStruct (_,n) -> "_" ^ n
10889 | RStringList _ -> "string[]"
10890 | RStructList (_,n) -> sprintf "_%s[]" n
10892 and c_error_comparison () =
10893 match fst style with
10897 | RInt64 _ -> "== -1"
10899 | RConstOptString _
10905 | RStructList (_,_) -> "== null"
10907 and generate_extern_prototype () =
10908 pr " static extern %s guestfs_%s (IntPtr h"
10909 (c_return_type ()) name;
10912 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10913 | FileIn n | FileOut n
10915 pr ", [In] string %s" n
10916 | StringList n | DeviceList n ->
10917 pr ", [In] string[] %s" n
10927 and generate_public_prototype () =
10928 pr " public %s %s (" (csharp_return_type ()) name;
10929 let comma = ref false in
10931 if !comma then pr ", ";
10936 | Pathname n | Device n | Dev_or_Path n | String n | OptString n
10937 | FileIn n | FileOut n
10939 next (); pr "string %s" n
10940 | StringList n | DeviceList n ->
10941 next (); pr "string[] %s" n
10943 next (); pr "bool %s" n
10945 next (); pr "int %s" n
10947 next (); pr "long %s" n
10951 and generate_call () =
10952 pr "guestfs_%s (_handle" name;
10953 List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (snd style);
10957 pr " [DllImport (\"%s\")]\n" library;
10958 generate_extern_prototype ();
10960 pr " /// <summary>\n";
10961 pr " /// %s\n" shortdesc;
10962 pr " /// </summary>\n";
10963 generate_public_prototype ();
10965 pr " %s r;\n" (c_return_type ());
10968 pr " if (r %s)\n" (c_error_comparison ());
10969 pr " throw new Error (guestfs_last_error (_handle));\n";
10970 (match fst style with
10973 pr " return r != 0 ? true : false;\n"
10975 pr " Hashtable rr = new Hashtable ();\n";
10976 pr " for (int i = 0; i < r.Length; i += 2)\n";
10977 pr " rr.Add (r[i], r[i+1]);\n";
10979 | RInt _ | RInt64 _ | RConstString _ | RConstOptString _
10980 | RString _ | RBufferOut _ | RStruct _ | RStringList _
10986 ) all_functions_sorted;
10992 and generate_bindtests () =
10993 generate_header CStyle LGPLv2plus;
10997 #include <stdlib.h>
10998 #include <inttypes.h>
10999 #include <string.h>
11001 #include \"guestfs.h\"
11002 #include \"guestfs-internal.h\"
11003 #include \"guestfs-internal-actions.h\"
11004 #include \"guestfs_protocol.h\"
11006 #define error guestfs_error
11007 #define safe_calloc guestfs_safe_calloc
11008 #define safe_malloc guestfs_safe_malloc
11011 print_strings (char *const *argv)
11016 for (argc = 0; argv[argc] != NULL; ++argc) {
11017 if (argc > 0) printf (\", \");
11018 printf (\"\\\"%%s\\\"\", argv[argc]);
11023 /* The test0 function prints its parameters to stdout. */
11027 match test_functions with
11028 | [] -> assert false
11029 | test0 :: tests -> test0, tests in
11032 let (name, style, _, _, _, _, _) = test0 in
11033 generate_prototype ~extern:false ~semicolon:false ~newline:true
11034 ~handle:"g" ~prefix:"guestfs__" name style;
11039 | Device n | Dev_or_Path n
11042 | FileOut n -> pr " printf (\"%%s\\n\", %s);\n" n
11046 pr " for (i = 0; i < %s_size; ++i)\n" n;
11047 pr " printf (\"<%%02x>\", %s[i]);\n" n;
11048 pr " printf (\"\\n\");\n";
11050 | OptString n -> pr " printf (\"%%s\\n\", %s ? %s : \"null\");\n" n n
11051 | StringList n | DeviceList n -> pr " print_strings (%s);\n" n
11052 | Bool n -> pr " printf (\"%%s\\n\", %s ? \"true\" : \"false\");\n" n
11053 | Int n -> pr " printf (\"%%d\\n\", %s);\n" n
11054 | Int64 n -> pr " printf (\"%%\" PRIi64 \"\\n\", %s);\n" n
11056 pr " /* Java changes stdout line buffering so we need this: */\n";
11057 pr " fflush (stdout);\n";
11063 fun (name, style, _, _, _, _, _) ->
11064 if String.sub name (String.length name - 3) 3 <> "err" then (
11065 pr "/* Test normal return. */\n";
11066 generate_prototype ~extern:false ~semicolon:false ~newline:true
11067 ~handle:"g" ~prefix:"guestfs__" name style;
11069 (match fst style with
11074 pr " sscanf (val, \"%%d\", &r);\n";
11077 pr " int64_t r;\n";
11078 pr " sscanf (val, \"%%\" SCNi64, &r);\n";
11081 pr " return STREQ (val, \"true\");\n"
11083 | RConstOptString _ ->
11084 (* Can't return the input string here. Return a static
11085 * string so we ensure we get a segfault if the caller
11086 * tries to free it.
11088 pr " return \"static string\";\n"
11090 pr " return strdup (val);\n"
11092 pr " char **strs;\n";
11094 pr " sscanf (val, \"%%d\", &n);\n";
11095 pr " strs = safe_malloc (g, (n+1) * sizeof (char *));\n";
11096 pr " for (i = 0; i < n; ++i) {\n";
11097 pr " strs[i] = safe_malloc (g, 16);\n";
11098 pr " snprintf (strs[i], 16, \"%%d\", i);\n";
11100 pr " strs[n] = NULL;\n";
11101 pr " return strs;\n"
11102 | RStruct (_, typ) ->
11103 pr " struct guestfs_%s *r;\n" typ;
11104 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11106 | RStructList (_, typ) ->
11107 pr " struct guestfs_%s_list *r;\n" typ;
11108 pr " r = safe_calloc (g, sizeof *r, 1);\n";
11109 pr " sscanf (val, \"%%d\", &r->len);\n";
11110 pr " r->val = safe_calloc (g, r->len, sizeof *r->val);\n";
11113 pr " char **strs;\n";
11115 pr " sscanf (val, \"%%d\", &n);\n";
11116 pr " strs = safe_malloc (g, (n*2+1) * sizeof (*strs));\n";
11117 pr " for (i = 0; i < n; ++i) {\n";
11118 pr " strs[i*2] = safe_malloc (g, 16);\n";
11119 pr " strs[i*2+1] = safe_malloc (g, 16);\n";
11120 pr " snprintf (strs[i*2], 16, \"%%d\", i);\n";
11121 pr " snprintf (strs[i*2+1], 16, \"%%d\", i);\n";
11123 pr " strs[n*2] = NULL;\n";
11124 pr " return strs;\n"
11126 pr " return strdup (val);\n"
11131 pr "/* Test error return. */\n";
11132 generate_prototype ~extern:false ~semicolon:false ~newline:true
11133 ~handle:"g" ~prefix:"guestfs__" name style;
11135 pr " error (g, \"error\");\n";
11136 (match fst style with
11137 | RErr | RInt _ | RInt64 _ | RBool _ ->
11139 | RConstString _ | RConstOptString _
11140 | RString _ | RStringList _ | RStruct _
11144 pr " return NULL;\n"
11151 and generate_ocaml_bindtests () =
11152 generate_header OCamlStyle GPLv2plus;
11156 let g = Guestfs.create () in
11160 String.concat " " (
11163 | CallString s -> "\"" ^ s ^ "\""
11164 | CallOptString None -> "None"
11165 | CallOptString (Some s) -> sprintf "(Some \"%s\")" s
11166 | CallStringList xs ->
11167 "[|" ^ String.concat ";" (List.map (sprintf "\"%s\"") xs) ^ "|]"
11168 | CallInt i when i >= 0 -> string_of_int i
11169 | CallInt i (* when i < 0 *) -> "(" ^ string_of_int i ^ ")"
11170 | CallInt64 i when i >= 0L -> Int64.to_string i ^ "L"
11171 | CallInt64 i (* when i < 0L *) -> "(" ^ Int64.to_string i ^ "L)"
11172 | CallBool b -> string_of_bool b
11173 | CallBuffer s -> sprintf "%S" s
11178 generate_lang_bindtests (
11179 fun f args -> pr " Guestfs.%s g %s;\n" f (mkargs args)
11182 pr "print_endline \"EOF\"\n"
11184 and generate_perl_bindtests () =
11185 pr "#!/usr/bin/perl -w\n";
11186 generate_header HashStyle GPLv2plus;
11193 my $g = Sys::Guestfs->new ();
11197 String.concat ", " (
11200 | CallString s -> "\"" ^ s ^ "\""
11201 | CallOptString None -> "undef"
11202 | CallOptString (Some s) -> sprintf "\"%s\"" s
11203 | CallStringList xs ->
11204 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11205 | CallInt i -> string_of_int i
11206 | CallInt64 i -> Int64.to_string i
11207 | CallBool b -> if b then "1" else "0"
11208 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11213 generate_lang_bindtests (
11214 fun f args -> pr "$g->%s (%s);\n" f (mkargs args)
11217 pr "print \"EOF\\n\"\n"
11219 and generate_python_bindtests () =
11220 generate_header HashStyle GPLv2plus;
11225 g = guestfs.GuestFS ()
11229 String.concat ", " (
11232 | CallString s -> "\"" ^ s ^ "\""
11233 | CallOptString None -> "None"
11234 | CallOptString (Some s) -> sprintf "\"%s\"" s
11235 | CallStringList xs ->
11236 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11237 | CallInt i -> string_of_int i
11238 | CallInt64 i -> Int64.to_string i
11239 | CallBool b -> if b then "1" else "0"
11240 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11245 generate_lang_bindtests (
11246 fun f args -> pr "g.%s (%s)\n" f (mkargs args)
11249 pr "print \"EOF\"\n"
11251 and generate_ruby_bindtests () =
11252 generate_header HashStyle GPLv2plus;
11257 g = Guestfs::create()
11261 String.concat ", " (
11264 | CallString s -> "\"" ^ s ^ "\""
11265 | CallOptString None -> "nil"
11266 | CallOptString (Some s) -> sprintf "\"%s\"" s
11267 | CallStringList xs ->
11268 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11269 | CallInt i -> string_of_int i
11270 | CallInt64 i -> Int64.to_string i
11271 | CallBool b -> string_of_bool b
11272 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11277 generate_lang_bindtests (
11278 fun f args -> pr "g.%s(%s)\n" f (mkargs args)
11281 pr "print \"EOF\\n\"\n"
11283 and generate_java_bindtests () =
11284 generate_header CStyle GPLv2plus;
11287 import com.redhat.et.libguestfs.*;
11289 public class Bindtests {
11290 public static void main (String[] argv)
11293 GuestFS g = new GuestFS ();
11297 String.concat ", " (
11300 | CallString s -> "\"" ^ s ^ "\""
11301 | CallOptString None -> "null"
11302 | CallOptString (Some s) -> sprintf "\"%s\"" s
11303 | CallStringList xs ->
11305 String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "}"
11306 | CallInt i -> string_of_int i
11307 | CallInt64 i -> Int64.to_string i
11308 | CallBool b -> string_of_bool b
11310 "new byte[] { " ^ String.concat "," (
11311 map_chars (fun c -> string_of_int (Char.code c)) s
11317 generate_lang_bindtests (
11318 fun f args -> pr " g.%s (%s);\n" f (mkargs args)
11322 System.out.println (\"EOF\");
11324 catch (Exception exn) {
11325 System.err.println (exn);
11332 and generate_haskell_bindtests () =
11333 generate_header HaskellStyle GPLv2plus;
11336 module Bindtests where
11337 import qualified Guestfs
11340 g <- Guestfs.create
11344 String.concat " " (
11347 | CallString s -> "\"" ^ s ^ "\""
11348 | CallOptString None -> "Nothing"
11349 | CallOptString (Some s) -> sprintf "(Just \"%s\")" s
11350 | CallStringList xs ->
11351 "[" ^ String.concat "," (List.map (sprintf "\"%s\"") xs) ^ "]"
11352 | CallInt i when i < 0 -> "(" ^ string_of_int i ^ ")"
11353 | CallInt i -> string_of_int i
11354 | CallInt64 i when i < 0L -> "(" ^ Int64.to_string i ^ ")"
11355 | CallInt64 i -> Int64.to_string i
11356 | CallBool true -> "True"
11357 | CallBool false -> "False"
11358 | CallBuffer s -> "\"" ^ c_quote s ^ "\""
11363 generate_lang_bindtests (
11364 fun f args -> pr " Guestfs.%s g %s\n" f (mkargs args)
11367 pr " putStrLn \"EOF\"\n"
11369 (* Language-independent bindings tests - we do it this way to
11370 * ensure there is parity in testing bindings across all languages.
11372 and generate_lang_bindtests call =
11373 call "test0" [CallString "abc"; CallOptString (Some "def");
11374 CallStringList []; CallBool false;
11375 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11376 CallBuffer "abc\000abc"];
11377 call "test0" [CallString "abc"; CallOptString None;
11378 CallStringList []; CallBool false;
11379 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11380 CallBuffer "abc\000abc"];
11381 call "test0" [CallString ""; CallOptString (Some "def");
11382 CallStringList []; CallBool false;
11383 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11384 CallBuffer "abc\000abc"];
11385 call "test0" [CallString ""; CallOptString (Some "");
11386 CallStringList []; CallBool false;
11387 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11388 CallBuffer "abc\000abc"];
11389 call "test0" [CallString "abc"; CallOptString (Some "def");
11390 CallStringList ["1"]; CallBool false;
11391 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11392 CallBuffer "abc\000abc"];
11393 call "test0" [CallString "abc"; CallOptString (Some "def");
11394 CallStringList ["1"; "2"]; CallBool false;
11395 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11396 CallBuffer "abc\000abc"];
11397 call "test0" [CallString "abc"; CallOptString (Some "def");
11398 CallStringList ["1"]; CallBool true;
11399 CallInt 0; CallInt64 0L; CallString "123"; CallString "456";
11400 CallBuffer "abc\000abc"];
11401 call "test0" [CallString "abc"; CallOptString (Some "def");
11402 CallStringList ["1"]; CallBool false;
11403 CallInt (-1); CallInt64 (-1L); CallString "123"; CallString "456";
11404 CallBuffer "abc\000abc"];
11405 call "test0" [CallString "abc"; CallOptString (Some "def");
11406 CallStringList ["1"]; CallBool false;
11407 CallInt (-2); CallInt64 (-2L); CallString "123"; CallString "456";
11408 CallBuffer "abc\000abc"];
11409 call "test0" [CallString "abc"; CallOptString (Some "def");
11410 CallStringList ["1"]; CallBool false;
11411 CallInt 1; CallInt64 1L; CallString "123"; CallString "456";
11412 CallBuffer "abc\000abc"];
11413 call "test0" [CallString "abc"; CallOptString (Some "def");
11414 CallStringList ["1"]; CallBool false;
11415 CallInt 2; CallInt64 2L; CallString "123"; CallString "456";
11416 CallBuffer "abc\000abc"];
11417 call "test0" [CallString "abc"; CallOptString (Some "def");
11418 CallStringList ["1"]; CallBool false;
11419 CallInt 4095; CallInt64 4095L; CallString "123"; CallString "456";
11420 CallBuffer "abc\000abc"];
11421 call "test0" [CallString "abc"; CallOptString (Some "def");
11422 CallStringList ["1"]; CallBool false;
11423 CallInt 0; CallInt64 0L; CallString ""; CallString "";
11424 CallBuffer "abc\000abc"]
11426 (* XXX Add here tests of the return and error functions. *)
11428 (* Code to generator bindings for virt-inspector. Currently only
11429 * implemented for OCaml code (for virt-p2v 2.0).
11431 let rng_input = "inspector/virt-inspector.rng"
11433 (* Read the input file and parse it into internal structures. This is
11434 * by no means a complete RELAX NG parser, but is just enough to be
11435 * able to parse the specific input file.
11438 | Element of string * rng list (* <element name=name/> *)
11439 | Attribute of string * rng list (* <attribute name=name/> *)
11440 | Interleave of rng list (* <interleave/> *)
11441 | ZeroOrMore of rng (* <zeroOrMore/> *)
11442 | OneOrMore of rng (* <oneOrMore/> *)
11443 | Optional of rng (* <optional/> *)
11444 | Choice of string list (* <choice><value/>*</choice> *)
11445 | Value of string (* <value>str</value> *)
11446 | Text (* <text/> *)
11448 let rec string_of_rng = function
11449 | Element (name, xs) ->
11450 "Element (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11451 | Attribute (name, xs) ->
11452 "Attribute (\"" ^ name ^ "\", (" ^ string_of_rng_list xs ^ "))"
11453 | Interleave xs -> "Interleave (" ^ string_of_rng_list xs ^ ")"
11454 | ZeroOrMore rng -> "ZeroOrMore (" ^ string_of_rng rng ^ ")"
11455 | OneOrMore rng -> "OneOrMore (" ^ string_of_rng rng ^ ")"
11456 | Optional rng -> "Optional (" ^ string_of_rng rng ^ ")"
11457 | Choice values -> "Choice [" ^ String.concat ", " values ^ "]"
11458 | Value value -> "Value \"" ^ value ^ "\""
11461 and string_of_rng_list xs =
11462 String.concat ", " (List.map string_of_rng xs)
11464 let rec parse_rng ?defines context = function
11466 | Xml.Element ("element", ["name", name], children) :: rest ->
11467 Element (name, parse_rng ?defines context children)
11468 :: parse_rng ?defines context rest
11469 | Xml.Element ("attribute", ["name", name], children) :: rest ->
11470 Attribute (name, parse_rng ?defines context children)
11471 :: parse_rng ?defines context rest
11472 | Xml.Element ("interleave", [], children) :: rest ->
11473 Interleave (parse_rng ?defines context children)
11474 :: parse_rng ?defines context rest
11475 | Xml.Element ("zeroOrMore", [], [child]) :: rest ->
11476 let rng = parse_rng ?defines context [child] in
11478 | [child] -> ZeroOrMore child :: parse_rng ?defines context rest
11480 failwithf "%s: <zeroOrMore> contains more than one child element"
11483 | Xml.Element ("oneOrMore", [], [child]) :: rest ->
11484 let rng = parse_rng ?defines context [child] in
11486 | [child] -> OneOrMore child :: parse_rng ?defines context rest
11488 failwithf "%s: <oneOrMore> contains more than one child element"
11491 | Xml.Element ("optional", [], [child]) :: rest ->
11492 let rng = parse_rng ?defines context [child] in
11494 | [child] -> Optional child :: parse_rng ?defines context rest
11496 failwithf "%s: <optional> contains more than one child element"
11499 | Xml.Element ("choice", [], children) :: rest ->
11500 let values = List.map (
11501 function Xml.Element ("value", [], [Xml.PCData value]) -> value
11503 failwithf "%s: can't handle anything except <value> in <choice>"
11507 :: parse_rng ?defines context rest
11508 | Xml.Element ("value", [], [Xml.PCData value]) :: rest ->
11509 Value value :: parse_rng ?defines context rest
11510 | Xml.Element ("text", [], []) :: rest ->
11511 Text :: parse_rng ?defines context rest
11512 | Xml.Element ("ref", ["name", name], []) :: rest ->
11513 (* Look up the reference. Because of limitations in this parser,
11514 * we can't handle arbitrarily nested <ref> yet. You can only
11515 * use <ref> from inside <start>.
11517 (match defines with
11519 failwithf "%s: contains <ref>, but no refs are defined yet" context
11521 let rng = StringMap.find name map in
11522 rng @ parse_rng ?defines context rest
11525 failwithf "%s: can't handle '%s' in schema" context (Xml.to_string x)
11528 let xml = Xml.parse_file rng_input in
11530 | Xml.Element ("grammar", _,
11531 Xml.Element ("start", _, gram) :: defines) ->
11532 (* The <define/> elements are referenced in the <start> section,
11533 * so build a map of those first.
11535 let defines = List.fold_left (
11537 function Xml.Element ("define", ["name", name], defn) ->
11538 StringMap.add name defn map
11540 failwithf "%s: expected <define name=name/>" rng_input
11541 ) StringMap.empty defines in
11542 let defines = StringMap.mapi parse_rng defines in
11544 (* Parse the <start> clause, passing the defines. *)
11545 parse_rng ~defines "<start>" gram
11547 failwithf "%s: input is not <grammar><start/><define>*</grammar>"
11550 let name_of_field = function
11551 | Element (name, _) | Attribute (name, _)
11552 | ZeroOrMore (Element (name, _))
11553 | OneOrMore (Element (name, _))
11554 | Optional (Element (name, _)) -> name
11555 | Optional (Attribute (name, _)) -> name
11556 | Text -> (* an unnamed field in an element *)
11559 failwithf "name_of_field failed at: %s" (string_of_rng rng)
11561 (* At the moment this function only generates OCaml types. However we
11562 * should parameterize it later so it can generate types/structs in a
11563 * variety of languages.
11565 let generate_types xs =
11566 (* A simple type is one that can be printed out directly, eg.
11567 * "string option". A complex type is one which has a name and has
11568 * to be defined via another toplevel definition, eg. a struct.
11570 * generate_type generates code for either simple or complex types.
11571 * In the simple case, it returns the string ("string option"). In
11572 * the complex case, it returns the name ("mountpoint"). In the
11573 * complex case it has to print out the definition before returning,
11574 * so it should only be called when we are at the beginning of a
11575 * new line (BOL context).
11577 let rec generate_type = function
11578 | Text -> (* string *)
11580 | Choice values -> (* [`val1|`val2|...] *)
11581 "[" ^ String.concat "|" (List.map ((^)"`") values) ^ "]", true
11582 | ZeroOrMore rng -> (* <rng> list *)
11583 let t, is_simple = generate_type rng in
11584 t ^ " list (* 0 or more *)", is_simple
11585 | OneOrMore rng -> (* <rng> list *)
11586 let t, is_simple = generate_type rng in
11587 t ^ " list (* 1 or more *)", is_simple
11588 (* virt-inspector hack: bool *)
11589 | Optional (Attribute (name, [Value "1"])) ->
11591 | Optional rng -> (* <rng> list *)
11592 let t, is_simple = generate_type rng in
11593 t ^ " option", is_simple
11594 (* type name = { fields ... } *)
11595 | Element (name, fields) when is_attrs_interleave fields ->
11596 generate_type_struct name (get_attrs_interleave fields)
11597 | Element (name, [field]) (* type name = field *)
11598 | Attribute (name, [field]) ->
11599 let t, is_simple = generate_type field in
11600 if is_simple then (t, true)
11602 pr "type %s = %s\n" name t;
11605 | Element (name, fields) -> (* type name = { fields ... } *)
11606 generate_type_struct name fields
11608 failwithf "generate_type failed at: %s" (string_of_rng rng)
11610 and is_attrs_interleave = function
11611 | [Interleave _] -> true
11612 | Attribute _ :: fields -> is_attrs_interleave fields
11613 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11616 and get_attrs_interleave = function
11617 | [Interleave fields] -> fields
11618 | ((Attribute _) as field) :: fields
11619 | ((Optional (Attribute _)) as field) :: fields ->
11620 field :: get_attrs_interleave fields
11621 | _ -> assert false
11623 and generate_types xs =
11624 List.iter (fun x -> ignore (generate_type x)) xs
11626 and generate_type_struct name fields =
11627 (* Calculate the types of the fields first. We have to do this
11628 * before printing anything so we are still in BOL context.
11630 let types = List.map fst (List.map generate_type fields) in
11632 (* Special case of a struct containing just a string and another
11633 * field. Turn it into an assoc list.
11636 | ["string"; other] ->
11637 let fname1, fname2 =
11639 | [f1; f2] -> name_of_field f1, name_of_field f2
11640 | _ -> assert false in
11641 pr "type %s = string * %s (* %s -> %s *)\n" name other fname1 fname2;
11645 pr "type %s = {\n" name;
11647 fun (field, ftype) ->
11648 let fname = name_of_field field in
11649 pr " %s_%s : %s;\n" name fname ftype
11650 ) (List.combine fields types);
11652 (* Return the name of this type, and
11653 * false because it's not a simple type.
11660 let generate_parsers xs =
11661 (* As for generate_type above, generate_parser makes a parser for
11662 * some type, and returns the name of the parser it has generated.
11663 * Because it (may) need to print something, it should always be
11664 * called in BOL context.
11666 let rec generate_parser = function
11667 | Text -> (* string *)
11668 "string_child_or_empty"
11669 | Choice values -> (* [`val1|`val2|...] *)
11670 sprintf "(fun x -> match Xml.pcdata (first_child x) with %s | str -> failwith (\"unexpected field value: \" ^ str))"
11672 (List.map (fun v -> sprintf "%S -> `%s" v v) values))
11673 | ZeroOrMore rng -> (* <rng> list *)
11674 let pa = generate_parser rng in
11675 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11676 | OneOrMore rng -> (* <rng> list *)
11677 let pa = generate_parser rng in
11678 sprintf "(fun x -> List.map %s (Xml.children x))" pa
11679 (* virt-inspector hack: bool *)
11680 | Optional (Attribute (name, [Value "1"])) ->
11681 sprintf "(fun x -> try ignore (Xml.attrib x %S); true with Xml.No_attribute _ -> false)" name
11682 | Optional rng -> (* <rng> list *)
11683 let pa = generate_parser rng in
11684 sprintf "(function None -> None | Some x -> Some (%s x))" pa
11685 (* type name = { fields ... } *)
11686 | Element (name, fields) when is_attrs_interleave fields ->
11687 generate_parser_struct name (get_attrs_interleave fields)
11688 | Element (name, [field]) -> (* type name = field *)
11689 let pa = generate_parser field in
11690 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11691 pr "let %s =\n" parser_name;
11693 pr "let parse_%s = %s\n" name parser_name;
11695 | Attribute (name, [field]) ->
11696 let pa = generate_parser field in
11697 let parser_name = sprintf "parse_%s_%d" name (unique ()) in
11698 pr "let %s =\n" parser_name;
11700 pr "let parse_%s = %s\n" name parser_name;
11702 | Element (name, fields) -> (* type name = { fields ... } *)
11703 generate_parser_struct name ([], fields)
11705 failwithf "generate_parser failed at: %s" (string_of_rng rng)
11707 and is_attrs_interleave = function
11708 | [Interleave _] -> true
11709 | Attribute _ :: fields -> is_attrs_interleave fields
11710 | Optional (Attribute _) :: fields -> is_attrs_interleave fields
11713 and get_attrs_interleave = function
11714 | [Interleave fields] -> [], fields
11715 | ((Attribute _) as field) :: fields
11716 | ((Optional (Attribute _)) as field) :: fields ->
11717 let attrs, interleaves = get_attrs_interleave fields in
11718 (field :: attrs), interleaves
11719 | _ -> assert false
11721 and generate_parsers xs =
11722 List.iter (fun x -> ignore (generate_parser x)) xs
11724 and generate_parser_struct name (attrs, interleaves) =
11725 (* Generate parsers for the fields first. We have to do this
11726 * before printing anything so we are still in BOL context.
11728 let fields = attrs @ interleaves in
11729 let pas = List.map generate_parser fields in
11731 (* Generate an intermediate tuple from all the fields first.
11732 * If the type is just a string + another field, then we will
11733 * return this directly, otherwise it is turned into a record.
11735 * RELAX NG note: This code treats <interleave> and plain lists of
11736 * fields the same. In other words, it doesn't bother enforcing
11737 * any ordering of fields in the XML.
11739 pr "let parse_%s x =\n" name;
11740 pr " let t = (\n ";
11741 let comma = ref false in
11744 if !comma then pr ",\n ";
11747 | Optional (Attribute (fname, [field])), pa ->
11749 | Optional (Element (fname, [field])), pa ->
11750 pr "%s (optional_child %S x)" pa fname
11751 | Attribute (fname, [Text]), _ ->
11752 pr "attribute %S x" fname
11753 | (ZeroOrMore _ | OneOrMore _), pa ->
11758 let fname = name_of_field field in
11759 pr "%s (child %S x)" pa fname
11760 ) (List.combine fields pas);
11764 | [Element (_, [Text]) | Attribute (_, [Text]); _] ->
11768 pr " (Obj.magic t : %s)\n" name
11772 | (Optional (Attribute (fname, [field])), pa) ->
11773 pr " %s_%s =\n" name fname;
11775 | (Optional (Element (fname, [field])), pa) ->
11776 pr " %s_%s =\n" name fname;
11777 pr " (let x = optional_child %S x in\n" fname;
11780 let fname = name_of_field field in
11781 pr " %s_%s =\n" name fname;
11782 pr " (let x = child %S x in\n" fname;
11784 ) (List.combine fields pas);
11788 sprintf "parse_%s" name
11791 generate_parsers xs
11793 (* Generate ocaml/guestfs_inspector.mli. *)
11794 let generate_ocaml_inspector_mli () =
11795 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11798 (** This is an OCaml language binding to the external [virt-inspector]
11801 For more information, please read the man page [virt-inspector(1)].
11806 generate_types grammar;
11807 pr "(** The nested information returned from the {!inspect} function. *)\n";
11811 val inspect : ?connect:string -> ?xml:string -> string list -> operatingsystems
11812 (** To inspect a libvirt domain called [name], pass a singleton
11813 list: [inspect [name]]. When using libvirt only, you may
11814 optionally pass a libvirt URI using [inspect ~connect:uri ...].
11816 To inspect a disk image or images, pass a list of the filenames
11817 of the disk images: [inspect filenames]
11819 This function inspects the given guest or disk images and
11820 returns a list of operating system(s) found and a large amount
11821 of information about them. In the vast majority of cases,
11822 a virtual machine only contains a single operating system.
11824 If the optional [~xml] parameter is given, then this function
11825 skips running the external virt-inspector program and just
11826 parses the given XML directly (which is expected to be XML
11827 produced from a previous run of virt-inspector). The list of
11828 names and connect URI are ignored in this case.
11830 This function can throw a wide variety of exceptions, for example
11831 if the external virt-inspector program cannot be found, or if
11832 it doesn't generate valid XML.
11836 (* Generate ocaml/guestfs_inspector.ml. *)
11837 let generate_ocaml_inspector_ml () =
11838 generate_header ~extra_inputs:[rng_input] OCamlStyle LGPLv2plus;
11843 generate_types grammar;
11847 (* Misc functions which are used by the parser code below. *)
11848 let first_child = function
11849 | Xml.Element (_, _, c::_) -> c
11850 | Xml.Element (name, _, []) ->
11851 failwith (\"expected <\" ^ name ^ \"/> to have a child node\")
11852 | Xml.PCData str ->
11853 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11855 let string_child_or_empty = function
11856 | Xml.Element (_, _, [Xml.PCData s]) -> s
11857 | Xml.Element (_, _, []) -> \"\"
11858 | Xml.Element (x, _, _) ->
11859 failwith (\"expected XML tag with a single PCDATA child, but got \" ^
11861 | Xml.PCData str ->
11862 failwith (\"expected XML tag, but read PCDATA '\" ^ str ^ \"' instead\")
11864 let optional_child name xml =
11865 let children = Xml.children xml in
11867 Some (List.find (function
11868 | Xml.Element (n, _, _) when n = name -> true
11869 | _ -> false) children)
11873 let child name xml =
11874 match optional_child name xml with
11877 failwith (\"mandatory field <\" ^ name ^ \"/> missing in XML output\")
11879 let attribute name xml =
11880 try Xml.attrib xml name
11881 with Xml.No_attribute _ ->
11882 failwith (\"mandatory attribute \" ^ name ^ \" missing in XML output\")
11886 generate_parsers grammar;
11890 (* Run external virt-inspector, then use parser to parse the XML. *)
11891 let inspect ?connect ?xml names =
11895 if names = [] then invalid_arg \"inspect: no names given\";
11896 let cmd = [ \"virt-inspector\"; \"--xml\" ] @
11897 (match connect with None -> [] | Some uri -> [ \"--connect\"; uri ]) @
11899 let cmd = List.map Filename.quote cmd in
11900 let cmd = String.concat \" \" cmd in
11901 let chan = open_process_in cmd in
11902 let xml = Xml.parse_in chan in
11903 (match close_process_in chan with
11905 | WEXITED _ -> failwith \"external virt-inspector command failed\"
11906 | WSIGNALED i | WSTOPPED i ->
11907 failwith (\"external virt-inspector command died or stopped on sig \" ^
11912 Xml.parse_string doc in
11913 parse_operatingsystems xml
11916 and generate_max_proc_nr () =
11917 pr "%d\n" max_proc_nr
11919 let output_to filename k =
11920 let filename_new = filename ^ ".new" in
11921 chan := open_out filename_new;
11924 chan := Pervasives.stdout;
11926 (* Is the new file different from the current file? *)
11927 if Sys.file_exists filename && files_equal filename filename_new then
11928 unlink filename_new (* same, so skip it *)
11930 (* different, overwrite old one *)
11931 (try chmod filename 0o644 with Unix_error _ -> ());
11932 rename filename_new filename;
11933 chmod filename 0o444;
11934 printf "written %s\n%!" filename;
11937 let perror msg = function
11938 | Unix_error (err, _, _) ->
11939 eprintf "%s: %s\n" msg (error_message err)
11941 eprintf "%s: %s\n" msg (Printexc.to_string exn)
11943 (* Main program. *)
11946 try openfile "HACKING" [O_RDWR] 0
11948 | Unix_error (ENOENT, _, _) ->
11950 You are probably running this from the wrong directory.
11951 Run it from the top source directory using the command
11956 perror "open: HACKING" exn;
11959 (* Acquire a lock so parallel builds won't try to run the generator
11960 * twice at the same time. Subsequent builds will wait for the first
11961 * one to finish. Note the lock is released implicitly when the
11964 (try lockf lock_fd F_LOCK 1
11966 perror "lock: HACKING" exn;
11969 check_functions ();
11971 output_to "src/guestfs_protocol.x" generate_xdr;
11972 output_to "src/guestfs-structs.h" generate_structs_h;
11973 output_to "src/guestfs-actions.h" generate_actions_h;
11974 output_to "src/guestfs-internal-actions.h" generate_internal_actions_h;
11975 output_to "src/guestfs-actions.c" generate_client_actions;
11976 output_to "src/guestfs-bindtests.c" generate_bindtests;
11977 output_to "src/guestfs-structs.pod" generate_structs_pod;
11978 output_to "src/guestfs-actions.pod" generate_actions_pod;
11979 output_to "src/guestfs-availability.pod" generate_availability_pod;
11980 output_to "src/MAX_PROC_NR" generate_max_proc_nr;
11981 output_to "src/libguestfs.syms" generate_linker_script;
11982 output_to "daemon/actions.h" generate_daemon_actions_h;
11983 output_to "daemon/stubs.c" generate_daemon_actions;
11984 output_to "daemon/names.c" generate_daemon_names;
11985 output_to "daemon/optgroups.c" generate_daemon_optgroups_c;
11986 output_to "daemon/optgroups.h" generate_daemon_optgroups_h;
11987 output_to "capitests/tests.c" generate_tests;
11988 output_to "fish/cmds.c" generate_fish_cmds;
11989 output_to "fish/completion.c" generate_fish_completion;
11990 output_to "fish/guestfish-actions.pod" generate_fish_actions_pod;
11991 output_to "ocaml/guestfs.mli" generate_ocaml_mli;
11992 output_to "ocaml/guestfs.ml" generate_ocaml_ml;
11993 output_to "ocaml/guestfs_c_actions.c" generate_ocaml_c;
11994 output_to "ocaml/bindtests.ml" generate_ocaml_bindtests;
11995 output_to "ocaml/guestfs_inspector.mli" generate_ocaml_inspector_mli;
11996 output_to "ocaml/guestfs_inspector.ml" generate_ocaml_inspector_ml;
11997 output_to "perl/Guestfs.xs" generate_perl_xs;
11998 output_to "perl/lib/Sys/Guestfs.pm" generate_perl_pm;
11999 output_to "perl/bindtests.pl" generate_perl_bindtests;
12000 output_to "python/guestfs-py.c" generate_python_c;
12001 output_to "python/guestfs.py" generate_python_py;
12002 output_to "python/bindtests.py" generate_python_bindtests;
12003 output_to "ruby/ext/guestfs/_guestfs.c" generate_ruby_c;
12004 output_to "ruby/bindtests.rb" generate_ruby_bindtests;
12005 output_to "java/com/redhat/et/libguestfs/GuestFS.java" generate_java_java;
12009 let cols = cols_of_struct typ in
12010 let filename = sprintf "java/com/redhat/et/libguestfs/%s.java" jtyp in
12011 output_to filename (generate_java_struct jtyp cols);
12014 output_to "java/Makefile.inc" generate_java_makefile_inc;
12015 output_to "java/com_redhat_et_libguestfs_GuestFS.c" generate_java_c;
12016 output_to "java/Bindtests.java" generate_java_bindtests;
12017 output_to "haskell/Guestfs.hs" generate_haskell_hs;
12018 output_to "haskell/Bindtests.hs" generate_haskell_bindtests;
12019 output_to "csharp/Libguestfs.cs" generate_csharp;
12021 (* Always generate this file last, and unconditionally. It's used
12022 * by the Makefile to know when we must re-run the generator.
12024 let chan = open_out "src/stamp-generator" in
12025 fprintf chan "1\n";
12028 printf "generated %d lines of code\n" !lines